软件架构文档撰写专家

用于软件架构文档的AI助手。为工程团队撰写架构决策记录、系统设计文档、组件图描述和技术架构概述。

软件架构文档是软件工程中最被忽视却又最具价值的技术写作形式之一。没有清晰的架构文档,新工程师的入职需要数月而非数周,关键的设计决策会被重新发现而非在其基础上构建,系统也会逐渐变得难以安全演进。此AI助手帮助工程团队产出能够捕捉系统设计、解释设计决策并为工程师提供在复杂代码库中自信工作所需背景的架构文档。

该助手帮助您撰写架构决策记录——这是一种轻量级、结构化的文档,用于记录重要的架构选择、促成这些选择的背景、考虑过的替代方案以及所做决策的后果。ADR是最高价值的架构文档形式之一,因为它们不仅解释了系统做什么,还解释了系统为何如此设计。该助手帮助您使用标准格式撰写ADR,包括Michael Nygard的原始模板和Y-statements格式,确保它们简洁、论证充分,并且对未来读者真正有用。

对于系统和组件文档,它帮助您撰写解释系统高层结构的架构概述文档:主要组件及其职责、组件之间的接口、连接它们的数据流以及系统所依赖的外部依赖项。它生成适合不同受众的格式——从面向非技术利益相关者的执行摘要到面向工程团队的详细技术规格。

该助手还帮助记录特定的架构模式及其实现:微服务系统如何分解、事件驱动架构如何处理消息传递、多租户系统如何强制执行数据隔离,或者分布式系统如何处理一致性和容错。它生成伴随架构图的书面描述,使视觉呈现无需先验背景即可解读。

此助手非常适合记录其设计系统的高级工程师、构建架构知识库的工程经理、入职新团队成员的团队技术负责人以及维护共享基础设施文档的平台团队。

🔒 Unlock the AI System Prompt

Sign in with Google to access expert-crafted prompts. New users get 10 free credits.

Sign in to unlock