团队文档命名规则

搭建一整套活动的过程中出现各种文档,各种版本的文档,各种版本不同人的文档……最后如何归档备份复盘拿来下次直接使用?

在此之前对文档命名并没有太多概念,多半采用直接中文命名报名表就用“报名表”,在复盘归档团队所有文件时,同事们各个版本的表放在一起……如果活动做的多了,第一期报名表,第二期报名表,第一期CC特训营报名表,第一期私董会报名表……虽然目前团队只做过一期活动(摊手),但考虑以后活动类型和次数逐渐增多,就知道做文档索引时会多崩溃。所以在复盘的时候去仔细了解了下命名规则。

这个整个过程其实是梳理对团队整个资源结构的理解。

命名原则

采用大驼峰式命名法,例如:HbDocName(文档命名手册)

  • 前后两个字母相连的单词重复是只写一个,例如:SOPrize (颁奖SOP,本是 SOP Prize)
  • 日期使用6位数字标注,默认忽略年份前两位,例如161105(2016年11月5日)

团队常用缩写

为达成共识方便写作,常用缩写如下:

文档命名规则1.0版(在teambition中,团队外的成员看不到==)

命名规则

常规命名结构:文档属性-类别/项目/负责人

1.先定位文档属性,比如是Hb,还是Info,还是Index,还是Tep
Tep,可模板化沿用的内容
Hb一般会链接到Info或Index中;方便进一步参考调用内容;
Index,主要存放索引,以后随着课程内容的增加和完善,需要把更多的文档汇总起来
Info,通常可以直接使用不需要再打开链接的内容

…………

这样在一个目录下浏览是,文档可以呈树状的结构展开:

例如Tep:


TepSignin~签到模板
TepScore~积分榜模板
TepSeat~席卡模板
TepCer~证书模板


版本号标注规则

可参考语义化版本控制的命名方式,介于归档备份文本都是最终文版,在版本控制上可以不做区分,但平时工作中沟通可以用到。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,819评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,937评论 25 709
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 14,375评论 4 61
  • 回到学校,又要开始第八周的学习。 位置换了,从最后一排换到第一排;从看不见黑板到看见黑板;从敢发呆到不敢发呆……每...
    浅忆漠恋阅读 2,515评论 0 0
  • 行情分析 一、上证指数的在前文我们根据多空双方的极端思路列举了两种走势,第一是多方的极端判断,就是突破三重顶后指数...
    颖悟yes阅读 1,508评论 0 0

友情链接更多精彩内容