docs-architect

Docs Architect - 技术文档架构师

技能概述

Docs Architect 是一个专业的技术文档生成技能，能够从现有代码库自动生成全面的技术文档，包括架构指南、设计模式分析和实现细节说明。

适用场景

1. 系统架构文档化

当需要为新系统或现有系统创建完整的架构文档时，Docs Architect 可以分析代码结构，识别关键组件及其关系，生成包含系统边界、核心组件交互和设计决策的详细文档。

2. 技术深度解析

当需要对复杂系统进行技术深度分析时，该技能能够从代码层面提取设计模式、架构决策和数据流信息，生成 10-100+ 页的综合性技术手册，适合架构评审和团队知识沉淀。

3. 新人入职培训材料

当需要为开发团队准备技术培训材料时，Docs Architect 可以生成包含执行摘要、架构概览、核心组件详解和故障排除指南的完整文档体系，帮助新成员快速理解系统全貌。

核心功能

1. 代码库深度分析

深入理解代码结构、模式和架构决策，识别关键组件之间的依赖关系，提取设计意图和实现细节，为文档生成奠定坚实的技术基础。

2. 分层文档架构

创建逻辑清晰的章节层次结构，设计渐进式的复杂度披露路径，规划架构图和可视化辅助，建立统一的术语体系，确保文档既全面又易于导航。

3. 多格式技术输出

生成 Markdown 格式的综合性技术文档，包含清晰的标题层次、语法高亮的代码块、结构化表格、项目符号列表、重要提示引用和代码文件链接，适合作为团队权威技术参考资料。

常见问题

Docs Architect 可以处理哪些类型的代码库？

Docs Architect 可以分析各种编程语言的代码库，包括但不限于 Python、JavaScript/TypeScript、Java、Go、Rust 等主流语言。它特别适合处理多层架构、微服务、单体应用等不同架构风格的系统。

生成的文档包含哪些内容？

生成的文档通常包含：执行摘要、架构概览、设计决策说明、核心组件详解、数据模型、集成点、部署架构、性能特征、安全模型以及术语表和参考附录。文档长度可达 10-100+ 页，根据代码库复杂度而定。

这个技能适合什么时候使用？

Docs Architect 应该在需要进行系统性文档化工作时主动使用，例如：创建架构指南、生成技术手册、进行系统深度分析、准备新人培训材料、进行架构评审前准备文档。对于简单的代码注释或 API 文档，建议使用其他更轻量的工具。