（1904期）Describe Design – 代码架构文档一键生成

代码架构文档一键生成 自动化代码架构文档生成工具，通过多阶段探索生成带Mermaid图表的技术文档，支持人机双读者，适合代码库理解与知识传承。 使用说明 核心用法 describe-design 是一款面向代码库研究的专业文档生成技能，采用五阶段工作流：从范围界定、初步探索、深度研究、文档草拟到最终定稿。用户指定待文档化的功能或系统后，该技能会自动扫描代码结构、追踪代码路径、识别组件依赖，最终输出包含架构图、组件说明、数据流描述和代码引用的完整Markdown文档。 显著优点 双受众设计：文档结构兼顾人类开发者与AI Agent的阅读习惯，支持知识传承与自动化处理 可视化输出：内置Mermaid图表生成（流程图、时序图），降低复杂系统理解门槛 代码引用规范：采用符号级引用（函数名、类名）而非易失效的行号或代码拷贝，确保文档长期可维护 探索边界清晰：明确定义"何时停止"的判断标准（能追踪happy path、能画出架构图、能说清组件交互），防止过度深入实现细节 潜在局限 依赖AI探索能力：深度研究阶段的效果受制于底层模型的代码理解能力 模板化输出：虽有"可适配"说明，但核心结构固定，对于高度特殊的架构可能需要大量手动调整 无实时验证：文档生成后不会自动验证代码引用是否仍有效，需人工维护 适合人群 技术负责人进行架构评审与文档沉淀 新成员快速熟悉复杂代码库 开源项目维护者生成标准化贡献指南 需要为AI Agent创建可解析代码地图的团队 常规风险 文档滞后风险：代码引用虽稳定，但大规模重构后符号可能更名，需版本化管理 AI幻觉风险：探索阶段模型可能误判组件关系，建议关键文档人工复核 敏感信息泄露：自动探索可能触及包含密钥、凭证的配置文件，需配合代码库访问控制 原始说明 Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and describe a system's design. Produces markdown documents with Mermaid diagrams and stable code references suitable for humans and AI agents.