美文网首页
团队文档命名规则

团队文档命名规则

作者: 出走De娜拉 | 来源:发表于2016-11-16 18:26 被阅读150次

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

在此之前对文档命名并没有太多概念,多半采用直接中文命名报名表就用“报名表”,在复盘归档团队所有文件时,同事们各个版本的表放在一起……如果活动做的多了,第一期报名表,第二期报名表,第一期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~证书模板


版本号标注规则

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

相关文章

  • 团队文档命名规则

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

  • vue学习笔记--API URI设计规范和javaScript开

    本文目录http常用方法简单的URI命名规则级联资源API URI命名规则其他命名规则变量命名规则函数命名规则常量...

  • 项目开发规范参考

    现有项目的开发规范文档 目录 命名规则文件命名 HTML规范 CSS规范 JS规范变量申明简写代码性能优化注释规范...

  • # 前端 Vue 开发规范

    规范目的 为提高团队协作效率便于后期优化维护输出高质量的文档(讨论即文档、注释即文档、代码即文档) 一 命名 1 ...

  • Python—PEP8编码和命名习惯

    代码编排 文档编排 空格的使用 原则:避免不必要的空格 命名习惯 下面关于类中属性的命名规则: 作者:zzwwsu...

  • iOS 说明文档

    为了方便项目维护及交接,特制定以下说明文档 1. 命名规则 详细命名更新在这里:https://www.jians...

  • 快速搭建一个TypeScript项目

    在团队开发中为了更好的协作,我们应该在项目中制定各种规则,比如:代码风格、变量命名、文件命名、git commit...

  • 【设计师必备】最全面实用的UI界面切图命名规范,你知道吗??

    关于UI界面的切图命名的规范,U妹觉得关键是在于团队能够有一个统一的规则,所以这里只介绍一种通用的命名规则,当然大...

  • 协同编辑作业说明

    目录 文件命名规则文件结尾规则技巧学习Log日志 详细内容如下: 一、文件命名规则文件命名规则有二: 以数字开头,...

  • Kotlin 编码规约

    Kotlin 编码规约 编码规范 本页包含当前 Kotlin 语言的编码风格。 源代码组织 命名规则 格式化 文档...

网友评论

      本文标题:团队文档命名规则

      本文链接:https://www.haomeiwen.com/subject/sgmrpttx.html