精细结构

目录

通用文档编写规范

  1. 文档包括技术文档业务文档数据库文档设计文档四种;
  2. 所有文档都用 Markdown 来编写,或者由其他更适合的形式来编写;
  3. 所有文档参照 中文文案排版指北 来编写;
  4. 日期格式不参照上述规则,而将所有日期全部合在一起,如:
    这条 ISSUSE 在 2019 年 12 月 25 日 发布        X
    这条 ISSUSE 在 2019年12月25日 发布             √
    
  5. 技术文档编写规范参照: 技术文档编写规范
  6. 业务文档编写规范参照: 业务文档编写规范
  7. 数据库文档编写规范参照: 数据库文档编写规范
  8. 设计文档编写规范参照: 设计文档编写规范