用途:该技能定义 Hack23 项目所需的完整架构文档集合,确保文档既支持当前运维,也支持未来规划,并遵循技术文档最佳实践。
主要能力:规定每个项目必须创建的文档,包括当前状态类(ARCHITECTURE.md 的 C4 上下文/容器/组件图、DATA_MODEL.md、FLOWCHART.md、STATEDIAGRAM.md、MINDMAP.md、SWOT.md)、未来状态类(对应的 FUTURE_* 文档)、安全类(SECURITY_ARCHITECTURE.md、FUTURE_SECURITY_ARCHITECTURE.md、THREAT_MODEL.md)以及补充类(README.md、.github/SECURITY.md、CONTRIBUTING.md、CLASSIFICATION.md、ADR/ 目录)。同时给出各文档的结构要求,例如 ARCHITECTURE.md 需含概览、C4 各级图、技术栈、部署架构、集成点与 ADR 链接;DATA_MODEL.md 需含 ER 图、实体描述、关系、索引、数据分类与保留策略;FLOWCHART.md 需含关键工作流、决策点、错误处理与性能考量;STATEDIAGRAM.md 需含状态、转换、状态不变量与终止状态;MINDMAP.md 与 SWOT.md 也各有规定章节。
使用方式:文档必须用 Markdown 编写,所有图表使用 Mermaid;超过 500 行的文档需含目录,顶部标注最后更新日期,链接相关文档,用 git 做版本管理,保持图表与代码同步,并每季度评审。禁止包含敏感信息、创建过时文档、跨文档重复信息或使用专有图表格式。资料中提供了 DATA_MODEL.md、FLOWCHART.md、SWOT.md 的示例结构。
适用场景:适用于需要系统化架构文档的软件项目,尤其是强调安全、透明与可维护性的工程团队。
限制:资料未提供该技能的具体安装命令、运行环境、收费方式或平台支持信息,暂未提供。