Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.67 KB

File metadata and controls

49 lines (34 loc) · 1.67 KB

文档

这个目录按文档用途组织。阅读时优先选择最能回答当前问题的文档。

从这里开始

操作指南

架构说明

运行时参考

项目说明

新增文档的写法

建议按下面几种结构写:

  • 操作指南:目标、前置条件、步骤、验证、排障、相关链接。
  • 参考文档:概要、字段/接口/变量、示例、注意事项。
  • 架构文档:背景、职责、非职责、流程、失败模式、相关决策。

不要把长期设计决策塞进总览文档。后续如果需要保留决策历史,可以新增 docs/decisions/