敏捷开发之设计文档

简介: 对于设计文档的一点体会就是,明确需求、精简语言、图文并绘、代码相辅、易于沟通。下文援引:http://blog.csdn.net/zzhdi/article/details/50929828在产品研发过程中经常需要编写很多文档,例如:需求文档、设计文档、API文档、验收文档等等。

对于设计文档的一点体会就是,明确需求、精简语言、图文并绘、代码相辅、易于沟通。

下文援引:http://blog.csdn.net/zzhdi/article/details/50929828

在产品研发过程中经常需要编写很多文档,例如:需求文档、设计文档、API文档、验收文档等等。团队成员要花费很多精力去维护众多的文档,甚至有“兄弟,我替你写代码,你替我写文档”的无奈。

敏捷开发宣言
* 个体和互动 胜于 流程和工具
* 可以工作的软件 胜于 详尽的文档
* 客户合作 胜于 合同谈判
* 响应变化 胜于 遵循计划

敏捷宣言的第二条“可工作的软件胜于详尽的文档”,很多人理解为敏捷开发不重视文档,甚至以此为借口逃避写文档。同样,在对待”敏捷开发是否需要架构设计”的问题上也有类似极端的看法。

敏捷宣言在写什么样的文档以及如何写方面并没有给出任何刚性的指导原则,那么在敏捷管理的项目中我们该如何编写文档呢?

首先,我们需要理解敏捷宣言背后的思想。
敏捷4条宣言都是在强调“价值”、“快速交付价值”、“为客户提供价值”的理念。换句话说,研发团队要把精力放在能够为客户带来价值的地方,避免在不产生价值或者ROI(投入回报率)低的任务上浪费时间。

其次,我们要理解文档的作用是什么?文档是用来准确传递信息,帮助理解事物,沉淀知识。

基于以上理解,在遇到是否要写文档的疑问时,可以通过回答两个问题来判断

  • 是否有比写文档更高效传递信息的方式?
  • 简陋的文档是否满足需要?

从文档的读者来划分

  • 读者是项目组外人员
    这类文档往往是需要编写的而且不能“简写”的。例如:用户手册、验收文档、API文档等。

  • 读者是项目组内人员
    这类文档能省则省,能简则简。如果能够在每天站会上沟通的,就可以不写。建议高层的系统架构图、内部API文档可以简写。
    如果项目Leader通过类似EasyPM这样管理工具能够查询到的信息,可以在周报中简写甚至省略。


对于可以“简写”的文档,可以考虑使用Markdown格式。

Markdown是一种简单易用的标记语言,用户可以使用这些标记符号以最小的输入代价生成极富表现力的文档。

EasyPM 的文档编辑器使用Markdown语法,并且实时保存/预览、支持代码高亮、文档评论以及全文搜索。在版本管理上,支持手动和自动进行版本管理。文档评论也支持@功能,可以高效地对文档进行评审。

墨匠
目录
相关文章
|
7月前
|
敏捷开发 开发框架 数据可视化
|
4月前
|
持续交付 C# 敏捷开发
“敏捷之道:揭秘WPF项目中的快速迭代与持续交付——从需求管理到自动化测试,打造高效开发流程的全方位指南”
【8月更文挑战第31天】敏捷开发是一种注重快速迭代和持续交付的软件开发方法,通过短周期开发提高产品质量并快速响应变化。本文通过问题解答形式,探讨在Windows Presentation Foundation(WPF)项目中应用敏捷开发的最佳实践,涵盖需求管理、版本控制、自动化测试及持续集成等方面,并通过具体示例代码展示其实施过程,帮助团队提升代码质量和开发效率。
77 0
|
敏捷开发 项目管理
深入理解Scrum:敏捷开发的核心原则和方法
Scrum强调迭代、协作、自组织和透明度,使团队能够更好地应对不断变化的需求和复杂性。Scrum方法的核心思想是通过一系列短期周期来交付功能,每个周期通常称为Sprint,以便及早获取用户反馈、适应变化并提供高质量的产品。
|
7月前
|
敏捷开发 Devops 测试技术
深入理解自动化测试框架设计原则与实践
【4月更文挑战第25天】在快速演变的软件行业中,自动化测试已成为持续集成和交付过程中不可或缺的一环。本文旨在探讨构建高效自动化测试框架的设计原则,并通过实际案例分析如何在实践中应用这些原则以提高测试效率和可靠性。通过深入剖析自动化测试框架的核心组件、架构设计和最佳实践,读者将获得构建和维护健壮自动化测试系统的深刻见解。
35 0
|
敏捷开发 数据可视化 测试技术
敏捷开发要点
敏捷开发是一种以人为核心,迭代、增量式的软件开发方法。它强调团队成员的自我管理、面对变化时的快速适应能力,以及持续的沟通和协作。
|
敏捷开发 测试技术 项目管理
​ 敏捷开发和传统开发的区别?以及Scrum敏捷管理工具推荐
Leangoo领歌一款永久免费的专业敏捷研发管理工具,它覆盖了敏捷项目研发全流程,包括小型团队敏捷开发,规模化敏捷SAFe,Scrum of Scrums大规模敏捷。能够支持多种场景,如:敏捷研发管理、敏捷项目管理、工作流管理、轻量级项目群管理、任务管理等。
|
敏捷开发 数据可视化 测试技术
敏捷开发方法和工具:让你的团队更高效、更灵活
Leangoo领歌是一款永久免费的专业敏捷开发管理工具,也提供私有部署。国产软件,提供端到端敏捷研发管理解决方案,包括小型团队敏捷开发,规模化敏捷SAFe,Scrum of Scrums大规模敏捷.
|
敏捷开发 关系型数据库 MySQL
用敏捷开发的思想,带你快速上手实战项目
教你学会如何看文档 教你学会如何“抄作业”,也就是官方示例,或者其他优秀项目的源码 教你学会如何用敏捷开发的思路,聚焦实现阶段性的目标
157 0
|
敏捷开发 数据库
文档驱动式超敏捷开发
    敏捷开发大家都不陌生,他对文档的态度是偏向于反对,但是也不是说一点文档都没有。他的说法是 代替文档。     那么敏捷开发为什么会这么认为呢?其实大家在做项目开发的时候都会有这样的体会:     时间紧任务重,哪有时间写文档呀?代码都写不过来。
1243 0
敏捷框架Scrum的核心要点(“3355”)
Scrum是敏捷实践中最知名的一套框架。对于初学 Scrum 的同学,领会精髓需要实践和时间,但借助对其中最成型的部分的了解,能最快速的一窥其概貌。虽不精确,但有助于建立宏观的体感。Scrum 的核心可以简单归纳为“3355”。
2329 0