用途:该技能用于更新已有的面向对象组件文档,输入为待更新的文档文件 ${file},通过分析对应组件代码,让文档与当前实现保持一致。
主要能力:
- 从文档 front matter 的 component_path 字段提取组件路径,或从文档内容推断路径。
- 分析当前组件实现,对比现有文档,识别设计模式与架构变化。
- 更新公共 API、接口、依赖、方法参数、返回值、异常、集成模式与数据流。
- 更新 last_updated 字段为当前日期,保留原有结构、格式与版本历史。
- 在组件显著扩展时新增章节,标记废弃功能或破坏性变更,更新示例、依赖列表、Mermaid 图。
- 针对 C#/.NET、Java、TypeScript/JavaScript、Python 提供语言相关的更新要点。
文档标准:遵循 C4 模型(Context、Containers、Components、Code)、Arc42 架构文档模板、IEEE 1016 软件设计描述标准,并采用敏捷文档原则,以开发者和维护者为主要读者。
使用方式:提供现有文档文件路径,技能会读取文档、定位组件路径、分析源码并就地更新原 Markdown 文件。输出保持原格式、标题层级和组织结构,并包含 front matter(title、component_path、version、date_created、last_updated、owner、tags)以及组件概览、架构、接口、实现细节、使用示例、质量属性、参考资料等章节模板。
限制与错误处理:若文档不存在,会提示文件位置;若文档中找不到组件路径,会请求澄清;若源码已移动,会建议更新路径;若存在重大架构变更,会突出破坏性变更;若源码访问不足,会记录相关限制。实际执行细节、发布渠道与依赖环境暂未提供。