今天看啥  ›  专栏  ›  逸言

如何提升架构文档编写效率与编写质量

逸言  · 公众号  · 程序员  · 2023-12-22 10:55
​高效地编写高质量的架构与设计文档至关重要,如果编写文档只是向客户交差,或者为了通过评审,这样的文档并无太大价值。文档固然写得完整而正确,但如果没有把架构知识(架构原则,架构决策与设计方案)及时传递给团队,并指导团队依照该文档进行进一步设计和开发,文档的价值就被削弱了。我之前在一个大型项目担任首席架构师。在架构阶段,逐渐发现我负责的团队在开展架构工作时,有陷入此问题的风险和趋势。我及时向团队与客户提出这一问题,发现大家感受一致。怎么解决这个问题?联想到架构设计中常用的分而治之思想,不妨对架构文档也如法炮制,通过化整为零、以总带分的形式组织文档,将架构文档分成两个层级。第一层级:顶层设计文档。采用企业架构方式规划和定义业务架构、应用架构、数据架构与技术架构的设 ………………………………

原文地址:访问原文地址
快照地址: 访问文章快照