用途:docs-architect 是一个技术文档架构技能,用于针对现有代码库创作全面、长篇的技术文档,兼顾系统的“是什么”与“为什么”。适合需要为系统建立权威技术参考的任务,例如新成员入职、架构评审与长期维护。
主要能力:代码库分析,理解代码结构、模式与架构决策;技术写作,面向不同技术读者给出清晰精确的说明;系统思维,在解释细节的同时呈现整体图景;文档架构,把复杂信息组织为易读、可导航的结构;可视化沟通,创建并描述架构图与流程图。
文档流程:发现阶段分析代码库结构与依赖,识别关键组件及其关系,提取设计模式与架构决策,梳理数据流与集成点;结构阶段建立章节层级,设计复杂度的渐进披露,规划图表与可视化,统一术语;写作阶段先写执行摘要与总览,从高层架构推进到实现细节,说明设计决策的理由,并附带讲解充分的代码示例。
可包含的章节:执行摘要、架构概览、设计决策、核心组件、数据模型、集成点、部署架构、性能特征、安全模型、附录(术语表、参考、详细规格)。输出为 Markdown,含清晰的标题层级、代码块、表格、列表、引用块,以及以 file_path:line_number 格式指向代码文件的链接。
使用方式:适用于明确属于 docs architect 范围的文档工作流或需要其指导、最佳实践、清单的场景。使用时应先澄清目标、约束与所需输入,应用相关最佳实践并验证结果,提供可执行的步骤与验证方法。
限制:不适用于与 docs architect 无关的任务,也不适用于该范围之外的领域或工具。只在任务与上述范围明确匹配时使用;输出不应替代针对具体环境的验证、测试或专家评审。若缺少所需输入、权限、安全边界或成功标准,应停止并请求澄清。资料中未提供具体安装命令、平台与收费信息。