架构文档(经常)很糟糕

在现实生活系统中,我们发现有着良好编写的代码,积极的团队和高效的系统 - 但是软件架构的知识往往隐藏在单个大脑中、分散的代码中或者仅仅是丢失了。

几个典型问题阻碍了许多软件项目 - 而arc42可以通过低成本高效地帮助减少或消除这些问题。

不存在或过时永久链接

第一个问题是缺少或过时的文档:

曾经在过去某个地方创建了文档。传言说很久以前它可能是正确的,但原始作者已经
不可知或消失了。这样的历史文献只是浪费磁盘空间,对任何人都没有任何价值。

混乱永久链接

第二个问题是混乱和令人困惑的文档。

一个非常混乱的办公桌这种文档经常是在没有明确目的的情况下创建的,由各种人员在没有适当协调的情况下创建。

这种文档混乱难以维护,通常被认为比有帮助更有害,因为缺乏适当的结构。

太多永久链接

一堆文件叠在一起你可以在足够大的草堆中藏任何一根针 - 而且没有人能够在其中有效地
找到它。这种文件堆看起来可能令人印象深刻 - 除非有人试图找到(或更新!)特定信息。

这种溢出通常发生在网络共享或维基上,当没有人关心文档结构和内容时。

痛苦永久链接

从典型开发人员的角度来看,文档通常是一种痛苦:

一个正在痛苦中尖叫的人形式主义、不恰当的工具和格式、缺少目标、不清晰的文档内容和如何记录的说明。利益相关者抱怨,文档笨拙又不灵活。创造力消失。人们成为开发人员不是为了这个。

arc42使文档高效且有效永久链接

arc42具有清晰、简单和有效的结构,可用于记录和传达您的软件系统。它被优化以提高可理解性和适应性。

arc42自然地引导您以易于理解的方式解释任何类型的架构信息或决策,并且易于维护。

无痛文档永久链接

arc42的用户喜欢其可理解性,这主要源于其标准化的结构。

但是他们真正喜欢的是使用基于arc42的架构文档所需的可管理工作量。我们称其
为“无痛文档”,使用arc42模板不需要额外的努力:

  • 您只描述您的利益相关者确实需要知道的事情。
  • 您解释了理解系统或个别设计决策所必需的事实和问题。
  • 您只追踪必须要做出的重要架构决策。

精简且轻量级永久链接

arc42旨在成为一个轻量级工具,可以轻松适应您的特定需求。