精细结构

目录

技术文档编写规范

1. 技术文档面对的是开发团队内部的同事；
2. 技术文档必须明确当前项目用到的技术，以及所对应的业务点；
3. 技术文档包括所有代码对外提供的接口，可以由 swagger 实现；
4. 技术文档必须描述清楚所有技术的规范点；
5. 各个项目的数据类型、长度限制等必须描述清楚；
6. 技术文档中必须明确标识所有可输入数据的数据类型、长度限制等所有详细信息；