SuperAPI AI 工具集

documentation-portfolio

办公与效率

查看项目

更新于 10-15 22:12

技能介绍

用途:为 Hack23 项目定义一套完整的架构文档组合,既支撑当前运营,也服务未来规划。

主要能力:要求产出多类文档。现状文档包括 ARCHITECTURE.md(C4 上下文、容器、组件视图)、DATA_MODEL.md、FLOWCHART.md、STATEDIAGRAM.md、MINDMAP.md、SWOT.md;未来规划包括对应的 FUTURE_ARCHITECTURE.md、FUTURE_DATA_MODEL.md、FUTURE_FLOWCHART.md、FUTURE_STATEDIAGRAM.md、FUTURE_MINDMAP.md、FUTURE_SWOT.md;安全文档包括 SECURITY_ARCHITECTURE.md、FUTURE_SECURITY_ARCHITECTURE.md、THREAT_MODEL.md;补充文档包括 README.md、.github/SECURITY.md、CONTRIBUTING.md。

使用方式与标准:文档须用 Markdown 编写,所有图表使用 Mermaid;超过 500 行需加目录;文档顶部标注最后更新日期;链接相关文档;图表与代码保持同步。不得包含密钥或凭据等敏感信息,不得保留过时文档,不得跨文档重复信息(应改为链接),不得使用专有图表格式。

结构要求:ARCHITECTURE.md 含概述、C4 各级图、技术栈、部署架构与集成点;DATA_MODEL.md 含 ER 图、实体属性、关系基数、数据分级与保留策略;FLOWCHART.md 含关键工作流、决策点、错误处理与性能考量;SWOT.md 含优势、劣势、机会、威胁、策略矩阵与行动项。

质量原则:遵循 AI FIRST,不接受初稿质量,至少迭代 2 次,通读输出并改进每个部分。

限制:资料未提供具体安装命令、平台支持、收费方式或实际使用步骤。