开发文档注意事项

特别注意:

• 文档读者是谁?
• 文档是需要维护的: 记录较少变动的东西
• 角度
• 时间: 时序图, 流程图, 泳道图, 事件, 创建销毁顺序
• 空间: 内存分布, 对象分布, 数据分布, 职责分布

文档模版

1. Introduction and Scope (关于文档自身, 比如: 文档的读者, 其他相关文档)
   1. Introduction
   2. Scope
   3. Related Documents
   4. Acronyms & Terminologies
2. Overview (项目的概况)
   1. Definitions and Concepts
   2. Constraints
   3. Dependencies
3. Functions/Modules/Layers (项目的功能/模块/层次)
1. 和业务密切的
1. Function and command mapping
2. 和业务不密切的
   1. Legalisation
   2. Deployment
   3. Versioning
   4. Exception Handling
   5. Exensibility
   6. Security
   7. Performance
   8. Logging
4. Benefits, assumptions, risks/issues