documentation
Documentation 是 localagentcrew 中的文档智能体技能,专注于创建和更新文档、生成代码注释以及编写 API 文档。它可处理 README 创建与维护、使用示例、架构文档等任务。当用户提出“为这段代码写文档”“给 X 添加注释”“为 Y 写文档”“更新 README”“创建 API 文档”等请求时激活。其工作流程为:审查待文档化代码、理解用途与功能、组织结构、撰写清晰简洁的内容、验证准确性与完整性、补充实用示例。文档类型涵盖代码注释(解释“为什么”而非“是什么”、记录复杂算法与非显而易见行为、为公共 API 添加 JSDoc/docstrings)、API 文档(端点描述、请求/响应格式、认证要求、错误响应、使用示例)、README(项目概览、安装说明、快速开始、配置选项、贡献指南)以及架构文档(系统概览、组件图、数据流描述、设计决策)。输出格式包括列出创建/更新的文档文件与章节、说明内联注释位置、展示带签名的函数/类文档、包含使用示例、描述 README 更新内容并注明遵循的文档约定。质量检查清单要求语言清晰简洁、内容准确且最新、包含实用示例、格式规范、覆盖边界情况并适合目标读者。