取决于你想要多么详细/正式.就决策注册而言,我们通常每个区域/决定使用一个文档,尽管最近我们一直在试验OneNote.
至少你想要记录(对于每个选项):
简明扼要的利弊(等等)清单通常就足够了 - 它不需要是一个大文档.
对于更深入/正式/复杂的场景,您需要更进一步,这是我们在这种情况下使用的格式:
摘要
评估标准
(这很重要,因为它列出了您用于评分可用选项的标准,包括权重等).
建议摘要
[选项1 ... N]
建议
我们在https://adr.github.io/收集有关架构决策记录的信息。
\nMADR为架构决策建立了一种简单的降价格式。
\n模板内容如下：
\n# {short title of solved problem and solution}\n\n## Context and Problem Statement\n\n{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story.\n You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}\n\n<!-- This is an optional element. Feel free to remove. -->\n## Decision Drivers\n\n* {decision driver 1, e.g., a force, facing concern, \xe2\x80\xa6}\n* {decision driver 2, e.g., a force, facing concern, \xe2\x80\xa6}\n* \xe2\x80\xa6 <!-- numbers of drivers can vary -->\n\n## Considered Options\n\n* {title of option 1}\n* {title of option 2}\n* {title of option 3}\n* \xe2\x80\xa6 <!-- numbers of options can vary -->\n\n## Decision Outcome\n\nChosen option: "{title of option 1}", because\n{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | \xe2\x80\xa6 | comes out best (see below)}.\n\n<!-- This is an optional element. Feel free to remove. -->\n### Positive Consequences\n\n* {e.g., improvement of one or more desired qualities, \xe2\x80\xa6}\n* \xe2\x80\xa6\n\n<!-- This is an optional element. Feel free to remove. -->\n### Negative Consequences\n\n* {e.g., compromising one or more desired qualities, \xe2\x80\xa6}\n* \xe2\x80\xa6\n\n<!-- This is an optional element. Feel free to remove. -->\n## Validation\n\n{describe how the implementation of/compliance with the ADR is validated. E.g., by a review or an ArchUnit test}\n\n<!-- This is an optional element. Feel free to remove. -->\n## Pros and Cons of the Options\n\n### {title of option 1}\n\n<!-- This is an optional element. Feel free to remove. -->\n{example | description | pointer to more information | \xe2\x80\xa6}\n\n* Good, because {argument a}\n* Good, because {argument b}\n<!-- use "neutral" if the given argument weights neither for good nor bad -->\n* Neutral, because {argument c}\n* Bad, because {argument d}\n* \xe2\x80\xa6 <!-- numbers of pros and cons can vary -->\n\n### {title of other option}\n\n{example | description | pointer to more information | \xe2\x80\xa6}\n\n* Good, because {argument a}\n* Good, because {argument b}\n* Neutral, because {argument c}\n* Bad, because {argument d}\n* \xe2\x80\xa6\n\n<!-- This is an optional element. Feel free to remove. -->\n## More Information\n\n{You might want to provide additional evidence/confidence for the decision outcome here and/or\n document the team agreement on the decision and/or\n define when this decision when and how the decision should be realized and if/when it should be re-visited and/or\n how the decision is validated.\n Links to other decisions and resources might here appear as well.}\n该模板位于https://github.com/adr/madr/blob/main/template/adr-template.md。
\n博客文章可持续建筑设计决策提出了以下文本：
\n\n\n在这样的背景下
\n<use case/user story u>，面对<concern c>我们决定去<option o>实现<quality q>、接受<downside d>。
在一些项目中，我们使用以下扩展：
\n\n\n在\n的背景下
\n<use case/user story u>，\n面对<concern c>\n我们决定<option o>\n并忽略<other options>\n以实现<system qualities/desired consequences>\n接受\n<downside d/undesired consequences>，因为\n<additional rationale>。
其他解决方案（包括 Markdown 模板）列于https://adr.github.io/。
\n| 归档时间： |
|
| 查看次数： |
8946 次 |
| 最近记录： |