describe-design

describe-design 是一款专注于代码库架构文档生成的专业工具技能。它通过系统化的五阶段工作流程，帮助开发团队将复杂的代码结构转化为清晰、可维护的架构文档。

核心用法遵循"范围定义→初始探索→深入研究→文档起草→最终定稿"的严谨流程。首先明确文档范围和目标受众，随后通过轻量级探索构建代码库心智模型，再深入追踪代码路径、识别组件依赖，最终生成包含 Mermaid 图表、稳定代码引用和术语表的标准化 Markdown 文档。整个过程强调在深入研究与过度探索之间保持平衡，确保文档既全面又聚焦。

显著优点体现在四个维度：首先是极致安全性，作为纯文档型资产，无脚本执行、无网络通信，从根本上杜绝了代码注入和数据泄露风险；其次是专业输出质量，内置标准化模板强制要求包含架构图、组件说明、数据流和配置指南，确保文档的完整性和一致性；第三是双受众设计，既为人类读者提供清晰的自然语言描述，又通过结构化表格和稳定引用方便 AI agent 理解；第四是工程化思维，强调使用文件路径和符号名而非行号，确保文档在代码重构后依然有效。

潜在局限性包括：作为 T3 来源的个人开发者作品，缺乏组织级背书；纯文档属性意味着所有操作需人工确认（如文件写入前必须获得明确授权），无法实现全自动化文档生成；对于超大型代码库，人工主导的探索模式可能效率较低；且文档质量高度依赖于使用者对代码库的理解深度，无法自动分析复杂业务逻辑。

适合的目标群体主要是技术团队中的架构师、Tech Lead 和技术写作者，特别适用于新成员入职培训、遗留系统知识沉淀、技术方案评审准备等场景。同时也适合需要与 AI 协作进行代码分析的开发者。

使用风险主要涉及流程性能：由于每个关键节点（如范围确认、文件路径确认）都需要人工介入，在大规模文档化项目中可能产生交互瓶颈。此外，虽然 skill 本身无外部依赖，但生成的 Mermaid 图表需要相应的渲染环境支持。