Skip to content

文档规范

文档中心不是简单堆文件,必须有固定规则,否则三个月后还是会乱。

基本原则

  • 所有正式项目文档统一收口到这个文档项目
  • 一个项目一个目录,一个目录一个入口页
  • 文档标题面向内部阅读,不面向代码实现细节
  • 对内发布只发文档站链接,不再发零散文件路径

文档分类

  • projects/:项目专题文档
  • standards/:规范、模板、维护规则
  • archive/:历史或废弃文档

每个项目至少要有的内容

  • 项目总览
  • 需求说明
  • 技术方案
  • 运行维护说明
  • 风险与投入产出

内部使用文档,请按项目和专题归档维护。