怎样才能写好项目文档

怎么写好文档

1. 从模仿开始

2. 从小文档开始

3. 从粗到细，迭代更新

4. 一些基本的画图技巧

• 线框图
• 流程图
• 时序图
• 各种格式的截图

一个完整项目过程需要的文档

1. 项目立项：
        原始需求文档
        可行性分析报告
        立项说明书
2. 需求相关的：
        原型设计文档
        产品设计文档
3. 系统设计相关的：
        技术方案文档
        详细设计文档
4. 开发相关的：
        代码规范文档
5. 测试相关的：
        测试用例
        测试验收报告
6. 运维相关的：
        部署文档
        故障报告
总结：
        其实没有特别的标准的，还是根据各个阶段需要。原则上就是：
        1、这件事需要讨论需要评审，要有文档作为讨论的依据，以及记录讨论的结果，比如各种设计文档；
        2. 这件事要有规范，要有文档保证规范统一，比如各种规范文档；
        3. 这件事要记录下来，作为以后的一个参考，比如各种报告、环境配置、操作手册、API文档等。

项目文档参考

        开源项目文档：Video-React - React Video Component

        ​​​Vue：​​https://redux.js.org/

        Redux：https://cn.vuejs.org/v2/guide/

        产品需求模板：https://www.jianshu.com/p/e89e97858be1

        微服务，从设计到部署：https://docshome.gitbooks.io/microservices/content/2-using-an-api-gateway.html