mrfangzheng

Hope and fear are useless. Be confident, and always be prepared for the worst.
  首页  :: 新随笔  :: 联系 :: 管理

项目文档需要多详细才好?

Posted on 2011-02-18 16:34  mrfangzheng  阅读(237)  评论(0编辑  收藏  举报
  1. 需求文档
    读者: 所有. 包括:系统使用者, 测试者, 设计者, 开发者
    越明确越好
  2. 设计文档
    读者: 设计者, 开发者
    设计文档的目的是让开发者对系统架构有一个大概的了解,并提供对难懂部分的解释. 具体设计还需开发者研究代码.
    设计文档不能太详细, 否则代码和文档很难同步
    文档只需包括
    1. 设计思想, 原则等不经常变的内容
    2. 一些很难用语言描述的图表
    3. 重要和非常规的设计
    4. 一些设计中的假设, 决定取舍, 优劣对比等