惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

The GitHub Blog
The GitHub Blog
雷峰网
雷峰网
小众软件
小众软件
博客园 - 【当耐特】
J
Java Code Geeks
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
Hugging Face - Blog
Hugging Face - Blog
腾讯CDC
Engineering at Meta
Engineering at Meta
aimingoo的专栏
aimingoo的专栏
A
About on SuperTechFans
H
Help Net Security
博客园_首页
P
Proofpoint News Feed
GbyAI
GbyAI
大猫的无限游戏
大猫的无限游戏
N
Netflix TechBlog - Medium
爱范儿
爱范儿
MyScale Blog
MyScale Blog
Blog — PlanetScale
Blog — PlanetScale
The Cloudflare Blog
MongoDB | Blog
MongoDB | Blog
酷 壳 – CoolShell
酷 壳 – CoolShell
Google DeepMind News
Google DeepMind News

博客园 - xiaosonl

学习手札#3 NHibernate缓存 产品的简单性 关于过度设计的思考(上) 让ASP.NET MVC的Controller输出不同类型数据 学习手札#2 故事点和小时数的思考 学习笔记#1 键值对数据库 SQLite数据迁移 探讨一种在Silverlight不普及情况下的部署策略 Silverlight产品布署策略 探讨一种Silverlight的异步编程模式 代码的注释 下半年要看完消化的技术类书籍 中小型企业的人员流失 谈谈Ruby On Rails和ASP.NET 工作中的系统学习 Uml中的关联与依赖关系 TDD与重构设计 C#中使用位运算来实现权限管理 Silverlight中JavaSciprt无法访问托管类抽象成员的解决方法
有用的文档
xiaosonl · 2010-04-30 · via 博客园 - xiaosonl

有用的文档

2010-04-30 00:33  xiaosonl  阅读(368)  评论(0)    收藏  举报

我是个反文档主义者,最主要的原因是因为我很懒,其实是不会写。随着开发项目的越来越大,开始认识到有些文档是不得不写的:

一. 常规的有用文档

1. 记录需求的文档,一切之起源,比如Scrum中的Backlog

2. 记录跟踪BUG的文档或工具,这点重要性勿容质疑。

3. 描述高层次架构设计的文档,虽然面对面交流比文档要好,可是对于架构这种涉及关联复杂,跨时间性长的文档,是必需要用文档描述的,随着时间的推移,人的大脑很难记住并展现软件的架构全景。

4. 任务计划/进度文档,任务的安排和分工,可视化项目的进度。

二. 非常规的有用文档:

1. 商业计划书,如果你在创业想找风投,这个就是敲门砖。

2. 产品远景规划,描述产品在将来的一个期望发展,可以时时用以激励团队,保持对目标的清晰。

3. 约定文档,团队合作在于相互协作,保持一致。一份约定文档,可以以书面的形式警惕拘束大家。一般是好的实践或不允许的实践的约定。