平时写文档的文档要求

开发文档分级要求

一级要求：

1. 列举项目中使用到的技术栈，以及对应的版本。如 Swift4, python3等。
2. 列举项目中使用到的第三方库，以及对应的版本。如Jquery3.5.1等。
3. 列举项目中交互的的类库以及相关的开发人员。 如Gavin (webservice)。
4. 绘制项目的业务逻辑流程图。
5. 绘制项目中主要功能描述图及相关功能简介。
6. 建立Git远程仓或本地仓，方便追踪历史改动。

二级要求：

1. 列举项目中主要提供及使用的接口，并作出分类解释。
2. 描述交互的类库使用及注意事项，包括调用的流程。
3. 提供项目使用调试的开发环境的说明文档，方便进一步运行测试。
4. 提供项目历史的编译版本，以及版本更改说明。
5. 提供项目中重大改动事件，如bug，需求。

三级要求：

1. 使用工具生成代码拓扑表，并描述接口相关信息。
2. 列举项目中未完成功能（TODO）及优化方案。
3. 重点描述项目中核心模块代码，包含流程，调用，测试，解释。