面向开发者：业务型的代码
1.参与指南
2.代码风格
3.架构设计
4.设计理念
5.实现细节
6.代码评审
7.代码集成
8.上线部署
9.踩坑指南
10.FAQ
面向用户：类库、框架型的代码
1.获取代码
2.快速上手
3.用法演示
4.接口描述
5.模块描述
6.高级话题（a.架构设计；b.最佳实践；c.竞品对比）
7.FAQ
文档管理：
confluence,Google Docs,git 或其他一些自建doc管理平台
推荐学习使用Markdown
技术文档应该怎么写
猜你喜欢
转载自www.cnblogs.com/biang/p/11671871.html
今日推荐
周排行