SuperAPI AI 工具集

docs-architect

写作与研究

查看项目

更新于 10-15 21:11

技能介绍

用途:docs-architect 用于从现有代码库生成完整技术文档,既说明系统“是什么”,也解释“为什么”这样设计。适用于文档架构相关任务,需要该领域指导、最佳实践或检查清单时使用;与文档架构无关或属于其他领域工具的任务不适用。

主要能力:代码库分析(理解代码结构、模式与架构决策)、技术写作、系统思维、文档架构组织、可视化沟通(描述架构图与流程图)。

文档流程:发现阶段分析代码库结构与依赖、识别关键组件及关系、提取设计模式与架构决策、梳理数据流与集成点;结构阶段建立章节层级、设计渐进式复杂度、规划图表、统一术语;写作阶段从执行摘要与概览开始,由高层架构推进到实现细节,说明设计决策理由,并附代码示例与解释。

输出特征:篇幅为 10 至 100 页以上的综合文档;深度覆盖全局到实现细节;风格技术但易读,复杂度渐进;格式含章节、小节与交叉引用;包含架构图、时序图与流程图(以文字详细描述)。

建议包含章节:执行摘要、架构概览、设计决策、核心组件、数据模型、集成点、部署架构、性能特征、安全模型、附录(术语表、参考与详细规格)。

最佳实践:解释设计决策背后的“为什么”,使用代码库中的具体示例,建立帮助读者理解系统的心智模型,记录当前状态与演进历史,包含故障排查指南与常见陷阱,为开发者、架构师、运维等不同读者提供阅读路径。

输出格式:Markdown,含清晰标题层级、带语法高亮的代码块、结构化数据表格、列表、重要提示引用块,以及使用 file_path:line_number 格式链接相关代码文件。

限制:资料未提供具体安装命令、收费方式、支持平台或效果数据;若需详细示例,需打开 resources/implementation-playbook.md。