软件征战团队为软件架构作念出聘请背后的原因经常被迷失。新团队成员经常对为什么征战东谈主员聘请 Ruby 或 React 这么的编程言语【FLAV-122】イケイケヤリマンギャル舌ベロペロM男ザーメン狩り RINO2014-12-25デジタルアーク&$digital ar158分钟，或者为什么他们在一个平台而不是另一个平台上托管软件感到困惑。
出于这个目的以及更多目的，负责软件架构征战的团队可能但愿记载他们的决策。尽管征战东谈主员、软件架构师和其他感深嗜深嗜的各方宽泛对软件架构华文档的价值捏怀疑作风，尤其是在他们合计代码文档自己的敏捷环境中，但精真金不怕火的文档关于正常运作的团队来说皆备是必不行少的。
正如咱们将看到的，软件架构文档关于征战团队尤其伏击，因为代码根柢无法讲演通盘故事。好多问题仍未取得解答。局外东谈主检察代码无法判断为什么架构以某种方式构建，或者进行改变是否会对系统的完满性产生负面影响，从而严重阻挠改变。
目次
什么是软件架构文档？为什么咱们应该记载软件架构？如何创建软件架构文档软件架构文档的最好实践软件架构中的文档技巧软件架构文档模板用于软件架构文档的 Baklib
什么是软件架构文档？
软件架构文档是软件系统架构的完满文档，包括三念念尔后行的联想决策、组件和一些特定的工件，举例图表、规格和描写。它告诉您代码是如何故及为怎样此构建的，并使团队成员和客户大略默契和改造软件。
软件架构文档旨在记载代码的以下区域：系统的非功能性需求系统的有谋略
驱动架构的决策过甚背后的推理
因此，诚然好的代码天然会阐明一切，但软件架构的某些方面是不言自明的，这即是好的文档的用武之地。它使软件的昔时休养和更新成为一个愈加可行的过程。
软件架构文档宽泛针对这些感深嗜深嗜的各方：
征战商软件架构师测试东谈主员质地保证维持客户行径样式司理
以及与软件科罚决策的架构方式成心害关系的任何其他东谈主。淌若您莫得记载软件架构，那么您将濒临无法了解其构建原因和方式的风险，在进行改变时可能会逆转和苟且之前的聘请。
为什么咱们应该记载软件架构？
咱们刚刚谈到了为什么软件征战团队可能想要记载他们的软件架构，当今咱们将更久了地探讨这么作念的原因。
常识分享
诚然文档在好多技巧孝敬者的任务列表中宽泛排在后头，但它关于软件架构界限的常识分享至关伏击。跟着时候的推移，团队成员可能会健忘为什么作念出决策，并冒着以不稳妥开始职责的方式改变软件的风险。记载软件架构意味着征战团队不错更好地分享常识并为昔时的孝敬者保留这些常识，这些孝敬者可能与原首创建者完全不同。
合作
正确的软件架构文档使团队大略更灵验地衔尾，因为所有利益相关者都不错默契系统。代码背后并非立即可想而知的意图变得愈加明晰，致使技巧水平较低的用户也不错默契代码如何故及为何故这种方式运行，从而齐全更好、更推行的业务决策。
可推广性
为了推广样式，您需要记载架构、表率和其他技巧细节背后的联想决策。淌若莫得正确记载，您的团队和架构就无法成长，因为伏击信息将会丢失，况兼您的软件可能注定会失败。第一次使用软件时，您的范围可能会受到完结，但跟着您接受更多功能和用例，这种情况可能会跟着时候的推移而改变。
镌汰休养老本
淌若您的软件要征战并跟上客户需求，您的征战东谈主员将需要对代码进行按时休养，以确保建立诞妄等。淌若您的软件架构已正确记载，这意味着任何征战东谈主员（致使是新征战东谈主员）表面上都不错加入并自信地进行改变。这镌汰了代码的休养老本，因为更新和修补愈加容易。
休养和当代化过期的软件
跟着软件的发展，它还必须闲适不同的且日益严格的条目，但利益相关者宽泛会由于变化的轨范而失去对软件的追踪。软件必须取得休养，更伏击的是，必须进行当代化，这需要更新的软件架构。可靠的文档会告诉您需要进行哪些改变以及哪些所在可能无法闲适圭臬。
决策维持
正确的文档不错维持架构师、征战东谈主员、样式司理和其他负责激动造访更多信息的各方的决策。尽管有些东谈主合计简单地检察代码就不错提供所有必要的细察力【FLAV-122】イケイケヤリマンギャル舌ベロペロM男ザーメン狩り RINO2014-12-25デジタルアーク&$digital ar158分钟，但现实是这种方法完全缺少意图和高下文。软件架构文档填补了这一空缺。
另请阅读：什么是软件文档？它的类型和最好实践
如何创建软件架构文档
当今，咱们将先容创建软件架构文档时需要采纳的才调。
了解受众和目的
与所有形势的写稿通常，您需要了解软件架构文档的有谋略受众。您开始可能会猜测其他软件架构师，但受众也可能包括征战东谈主员、技巧作者、样式司理和客户。宽泛理智的作念法是针对不同的受众制定不同的文档，因为可能与某些受众相关的信息可能会散播其他受众的驻防力或使其不知所措。
集中现存信息
您想要为软件架构创建的文档可能也曾以某种形势存在。淌若您集中现存材料，这将简约您在文档过程中的时候，并确保您充分诳骗您的资源。接管这种方法不错使您的所有典质品更有可能是最新且准确的，并将所有伏击信息保存在一个所在。
聘请文档方式
您需要决定是否要将文档呈现为图像、文本、视频或上述的某种组合。不同的方式需要不同的资源，况兼跟着时候的推移，更新或翻译成多言语内容会变得愈加贵重。有计划哪种方式最恰当您的用户况兼具有最低的休养老本，以确保对文档的捏续应允。
概述文档
在运转创建遍及软件架构文档之前，请确保开始构建一个大纲，以便您了解它们是如何组合在一谈的。您可能会有好多衔尾者参与您的文档做事，因此每个东谈主都需要有一个不错使用的道路图，就像他们使用软件代码通常。
变更不断和版块戒指
您的软件架构文档会跟着时候的推移而变化，因此您需要有一个认确凿变更不断系统以及版块戒指限定。版块应在保捏原始版块完满的情况下进行更新，以防出现争议或需要铲除，并让团队中的每个东谈主随时了解文档的最新版块。
包括附录和参考文献
在创建软件架构文档的过程中，您可能会参考外部资源和材料。确保包含附录和参考文献，以便文档用户不错查找原始来源并找到更多信息，确保您的文档全面且可靠。
按时休养和更新
软件架构文档的最终家具历久不会完成，必须跟着系统的改造、改变和更新而进行拯救。高质地的文档准确地反馈了系统的细节，让用户确信它照实有用。这需要跟着软件架构的发展按时休养和更新文档，同期保留原始版块以供参考。
软件架构文档的最好实践
当今有计划这些用于齐全软件架构文档的最好实践。
1. 在征战阶段实施文档
淌若您或然候，完满的文档应该被视为原型的一部分，而不是过后的想法。文档应该与代码通常伏击，因为它为征战软件的关节利益相关者提供了观点和信息。伏击文档应与代码一谈生成，以跟上络续发展的家具的轨范。
2. 仅记载您需要的内容并保捏最新
完满的文档并不料味着您记载所有内容 - 您应该只记载您需要的内容，不然可能会导致用户感到不知所措并建议他们，因为他们合计文档过于强盛。简略、相关且最新的文档比遍及冗长的文档更能闲适用户的需求。这里的有谋略是提供敷裕的文档，而不是太多。
3. 不同利益相关者的文献
正如咱们曾做买卖酌过的，您将需要针对不同利益相关者的不同形势的文档。软件征战团队中有好多扮装可能对软件架构文档感深嗜深嗜，如下所示：
征战商
天然，征战东谈主员会对软件系统的细节感深嗜深嗜，包括表率、依赖关系和组件关系。为了最灵验地征战代码，征战东谈主员必须了解软件架构，从而使他们大略幸免破赖事物或进行次优改变。
测试东谈主员
悠悠色测试东谈主员负责故意志地尝试苟且软件以查验弊端，因此，他们必须对其架构和联想决策有久了的了解，以便他们不错创建灵验的测试用例。
样式司理
样式司理必须对软件架构有一个平凡的概述，以匡助他们了解什么是可能的并激动样式上前发展。分派资源需要了解软件的完结以及在合理的时候内完成某些里程碑所需的手段。
技巧作者
技巧作者皆备必须了解系统架构才能为用户创建灵验且有用的文档。所有文档都是互相关联的，需要示知不同类型文档的作者。对文档感深嗜深嗜的软件架构师也可能受益于专科技巧作者的匡助。
4.幸免歧义并保捏简略
当您的利益相关者正在寻找相关软件架构的文档时，他们需要您幸免歧义并保捏简略。淌若您援用特定组件，请确保与您的定名商定和术语保捏一致。
5. 缜密的可造访性
缜密的可造访性关于在文档派系中搜索特定信息的用户相配伏击，因此您需要结伙搜索内容的功能，并对某些用户和内容的造访权限进行完结。保捏遵守的相关性和有用性是文档被接管的关节。
软件架构中的文档技巧
当今咱们将望望软件架构文档中的这些常见技巧。
图表
或然，莫得比通过可视化图表（宽泛使用和洽建模言语（UML））更好的方式来抒发软件架构了。淌若您想向用户讲解系统的联想，包括系统各部分如何协同做事，以及信息如安在系统的不同部分之间流动，那么图表是一个有用的器具。
文本文档
另一方面，文本或然是默契更复杂的不雅点的惟一方法，这在记载软件架构时尤其伏击。使用文本文档不错匡助您讲解高档看法、小心阐明组件的功能等等。
羼杂文档
天然，使用图表和文本的组合宽泛是向不同的用户群展示文档的最好科罚决策。图表不错纵情复制，并附有笔墨来讲解您的风趣。
软件架构文档模板
这是一个证据 arc42 的通用软件架构文档模板。它是开源的况兼完全免费使用，摒除了构建软件架构文档的横祸。
用于软件架构文档的 Baklib
Baklib 是一个超卓的平台，旨在简化和普及创建和不断软件架构文档的历程。在软件征战界限，明晰而全面的文档是顺利的样式实践、衔尾和常识保留的关节构成部分。 Baklib 提供了专为软件架构师、征战东谈主员和技巧作者量身定制的用户友好且功能强盛的科罚决策，使他们大略毛糙高效地创建、休养和分享软件架构文档。
回来
最终，征战、更新、休养软件以及添加新功能的东谈主可能不是开始构建该软件的东谈主。出于这个原因，以及前边提到的其他原因，记载您的软件架构以确保您的软件接续灵验运行是一个相配好的主意。淌若莫得稳妥的文档，软件团队可能会堕入杂沓词语并迷失方针。当工程师离开他们的职位况兼他们的继任者不知谈为什么作念出某些决定时，软件架构变得难以默契。
诚然文档可能并不老是软件架构师的弘大任务【FLAV-122】イケイケヤリマンギャル舌ベロペロM男ザーメン狩り RINO2014-12-25デジタルアーク&$digital ar158分钟，但您的团队成员和用户将感谢您所作念的致力。