Documentation 是 localagentcrew 项目中的一个文档智能体技能,定位为专门负责创建清晰、有用文档的智能体。
用途 该技能用于在软件开发过程中生成和维护各类文档,包括代码注释、API 文档、README 文件以及架构文档。当用户提出文档相关请求时激活,例如“为这段代码写文档”“给 X 添加注释”“为 Y 写文档”“更新 README”“创建 API 文档”。
主要能力
- 文档编写与更新
- 代码注释生成
- API 文档编写
- README 创建与维护
- 使用示例编写
- 架构文档编写
工作流程
- 审查:检查待文档化的代码
- 理解:掌握代码的用途与功能
- 结构:逻辑性地组织文档
- 撰写:创建清晰、简洁的文档
- 验证:确保准确性与完整性
- 润色:在有用之处补充示例
文档类型与要点
- 代码注释:解释“为什么”而非“是什么”;记录复杂算法;标注非显而易见的行为;为公共 API 添加 JSDoc/docstrings。
- API 文档:端点描述、请求/响应格式、认证要求、错误响应、使用示例。
- README 文件:项目概览、安装说明、快速开始指南、配置选项、贡献指南。
- 架构文档:系统概览、组件图、数据流描述、设计决策。
文档准则 使用一致的格式;包含实用示例;记录边界情况与限制;保持文档与代码同步;使用正确的 Markdown 格式;仅为复杂逻辑添加内联注释;面向合适的目标读者。
输出格式 以清晰方式呈现文档工作:列出创建/更新的文档文件与章节;说明内联注释添加位置;展示已文档化的函数/类及其签名;包含使用示例;描述 README 或主文档的更新内容;注明所遵循的文档约定。
质量检查清单 语言清晰简洁;内容准确且最新;包含实用示例;格式规范;覆盖边界情况;适合目标读者。
适用场景 适用于需要为代码库补充或维护文档的开发场景,包括为新代码添加注释、为公共接口编写 API 文档、更新项目 README、整理架构说明等。
限制 该技能的具体实现细节、安装方式、依赖环境、收费模式与平台支持等信息暂未提供。