SuperAPI AI 工具集

docs-architect

通用与其它

查看项目

更新于 10-16 02:31

技能介绍

用途:docs-architect 是一个技术文档架构技能,专门从现有代码库出发,编写覆盖系统“是什么”与“为什么”的长篇综合文档。适用于文档架构相关任务与工作流,需要相关指导、最佳实践或清单时使用;与文档架构无关的任务,或需要其他领域工具时不适用。

主要能力:代码库分析(理解代码结构、模式与架构决策)、技术写作(面向不同技术读者的清晰精确说明)、系统思维(既见全局又讲清细节)、文档架构(把复杂信息组织成易读易导航的结构)、可视化沟通(描述架构图与流程图)。

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

输出特征:篇幅为 10 至 100 页以上的综合文档;深度从鸟瞰视图到实现细节;风格技术化但可读,复杂度渐进;格式含章节、小节与交叉引用;视觉部分详细描述架构图、时序图与流程图。建议包含的章节有执行摘要、架构概览、设计决策、核心组件、数据模型、集成点、部署架构、性能特征、安全模型与附录。

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

输出格式:以 Markdown 生成文档,包含清晰的标题层级、带语法高亮的代码块、结构化数据表格、列表项目符号、重要说明引用块,以及使用 file_path:line_number 格式链接到相关代码文件。

限制:资料未提供具体安装命令、收费方式、支持平台或效果数据,暂未提供。