用途:为面向对象组件创建新文档,或在分析当前实现后更新已有组件文档文件。
模式判断:用户提供已有 Markdown 文档、指向 docs 路径或要求刷新修订时用 update 模式,遵循 references/update-mode.md;用户提供源码文件或文件夹、指向组件路径或要求从代码生成文档时用 create 模式,遵循 references/create-mode.md。若同时提供代码与已有文档,则以已有文档为输出目标、以当前源码为事实来源。请求含糊时按路径类型推断:已有 Markdown 文档为 update,源码/组件路径为 create。
文档标准:遵循 C4 模型层级(Context、Containers、Components、Code)、Arc42 架构文档模板、IEEE 1016 软件设计描述标准与敏捷文档原则,主要面向开发者与维护者。
分析要点:确定组件边界与输入类型;检查类结构、继承、组合与接口;识别设计模式、架构决策与集成点;记录或刷新公共 API、接口、依赖与用法;捕获方法参数、返回值、异步行为、异常与生命周期;评估性能、安全、可靠性、可维护性与可扩展性;推断数据流与协作关系;文档须基于实现,不虚构代码不支持的行为。
输出要求:以 assets/documentation-template.md 为规范章节清单与基线结构;使用 Markdown,含清晰标题层级、必要表格、代码块示例,架构关系可用 Mermaid 图;示例与接口描述须匹配当前实现;只写代码、项目结构、配置或明确假设可支撑的信息;覆盖不完整时明确说明限制。
语言优化:C#/.NET 关注 async/await、依赖注入、配置、释放与选项模式;Java 关注 Spring、注解、异常处理、打包与依赖注入;TypeScript/JavaScript 关注模块、异步模式、类型、npm 依赖与运行时边界;Python 关注包、虚拟环境、类型提示、测试与依赖管理。
错误处理:路径不存在时说明期望路径及所需输入类型;找不到相关源码时记录缺口并建议可能位置;无法推断文档目标时说明歧义,仅在无法推断时询问缺失路径;代码使用非标准架构模式时记录自定义做法而非套用通用模式;源码访问不完整时基于现有证据继续并明确标注未支撑章节。
流程:判断模式;检查组件实现及相关文件;以模板为脚手架;应用对应模式规则;产出或修订文档,使图、示例、接口、依赖与质量属性反映当前实现。完成标准:文档明确组件目的、架构、接口、实现细节、用法、质量属性与参考;前置字段准确;示例与图匹配实现;未知、缺口与假设均明确标注。