谷歌的设计文档

主要观点:Google 软件工程文化的关键元素之一是使用设计文档定义软件设计,设计文档在项目生命周期早期解决问题更有效,能实现多种功能如早期识别设计问题等,且文档内容无严格指南但有一定结构,包括上下文和范围、目标和非目标、实际设计等部分,还需考虑何时写、设计文档的生命周期及结论等。
关键信息

  • 设计文档是在编码前创建的非正式文档,记录高层实现策略和关键设计决策及权衡。
  • 设计文档结构包括上下文和范围、目标和非目标、实际设计(含系统上下文图等)、考虑的替代方案、横切关注点等部分。
  • 决定是否写设计文档需权衡组织共识等好处与创建文档的额外工作,设计文档生命周期包括创建和快速迭代、审查、实施和迭代、维护和学习。
    重要细节
  • 设计文档可解决早期问题,如早期识别设计问题、达成组织共识等。
  • 不同部分的具体内容,如上下文和范围部分只需提供粗略概述,目标和非目标部分要明确列出等。
  • 设计文档生命周期各阶段的特点,如创建和迭代阶段通过与同事分享文档获取反馈,审查阶段有多种形式及价值等。
  • 结论部分提到写设计文档的考虑因素,如对软件设计不确定、需涉及高级工程师等。
阅读 9
0 条评论