用途:为 Hack23 组织定义并执行架构文档标准,覆盖 C4 模型系统分解、ADR(架构决策记录)与未来状态规划,统一各仓库的文档模式。
主要能力:要求每个项目至少包含 C4 一级系统上下文图,展示系统、外部参与者及带协议与格式的数据流;二级容器图展示主要可部署单元;三级组件图用于复杂模块;四级代码图可选,仅用于关键或复杂算法。提供 ADR 模板(状态、上下文、决策、后果含正面/负面/风险),命名规范为 docs/adr/ADR-NNNN-short-title.md,编号四位补零。未来状态规划要求维护 ARCHITECTURE.md、FUTURE_ARCHITECTURE.md、SECURITY_ARCHITECTURE.md、DATA_MODEL.md、FLOWCHART.md、MINDMAP.md 等文档,并提供分阶段迁移模板与回滚计划。图表工具链以 Mermaid 为主,PlantUML 与 C4-PlantUML 为备选,附图表检查清单。跨仓库要求统一命名、至少含 C4 一级、维护 FUTURE_*.md、交叉引用依赖系统、图表标注版本或日期,并对齐 ISO 27001、NIST CSF、CIS 等控制项。
使用方式:在编写或评审架构文档、创建 ADR、规划未来状态迁移、生成 CIA 平台 C4 图时使用。
限制:不适用于代码级文档(用 JavaDoc)、安全专项架构(用 security-documentation 技能)和运维手册(用 aws-cloudwatch-monitoring 技能)。具体安装命令与调用方式暂未提供。