目录
在工作中和github上看了很多不像样的技术文档以后,2020年,我准备了一门面向大学生和工程师的技术文档写作课,并分享了幻灯片,可以在这里下载 敏捷开发文档写作课程.pdf-专业指导文档类资源-CSDN下载。
希望通过这门课,能帮助大家完成以下的目标:
-
掌握撰写敏捷开发项目文档的基本流程和方法;
-
掌握撰写敏捷开发项目文档的基本内容;
-
锻炼获取、评估和传达信息的科学和工程实践能力。
1 战略上重视:理解撰写文档的目的
写文档不是没事找事,也不是为了记录没有意义的内容。在紧张的敏捷开发过程中,如何最小化地撰写敏捷开发的文档?需要从以下方面去了解。
-
敏捷开发项目文档的为什么和是什么
-
如何写好用户故事和分解用户故事
-
如何写好设计文档
-
如何写好代码发布和系统维护的文档
2 技术文档写作的学习内容
- 解释为什么需要撰写敏捷开发项目的文档。
- 介绍撰写敏捷开发项目文档的结构。提问:回忆软件工程的过程和敏捷开发的流程。
- 介绍评价文档的总体质量标准:准确性、完整性、清晰性。
- 介绍用户故事的概念。描述用户故事的例子。介绍书写用户故事的逻辑方法以及注意事项。介绍如何评价用户故事的质量。
- 介绍设计文档的内容:包括架构设计图、API文档、数据库设计图。
- 介绍如何评价设计文档的质量。
- 介绍代码发布及维护的相关文档的内容,展示github上质量较差的文档,详细介绍相关文档的结构。
- 介绍如何评价代码发布及维护的相关文档。
3 撰写文档的重点和难点
撰写合格的文档,需要解决以下重点和难点:
-
敏捷开发项目文档的结构和功能;
-
敏捷开发项目文档的写作方法和内容;
-
评价文档质量的标准。
4 PPT内容参考
我准备了59页的内容,下面分享一些片子。
5 参考资源
- 用户故事估算技巧 用户故事估算技巧_敏捷_Jay Fields_InfoQ精选文章
- 如何切分用户故事 如何切分用户故事_敏捷_Dan Puckett_InfoQ精选文章
- 物联网大数据开放平台 https://github.com/taosdata/TDengine/
- 文档参考链接Free Agile project management templates and resources - David Hodder
- 文档模板Scrum Documentation Template | Info-Tech Research Group
希望大家在从事计算机相关工作的过程中,不仅能留下有价值的作品,也能留下启发和指导他人的技术文档。
如果大家在写作技术文档的过程中,有疑问,请留言和我交流吧。