用途:当用户需要编写或改进 README.md,创建入门、集成、教程、操作指南、FAQ、故障排查或产品文档,或希望根据现有代码与配置生成文档、使文档与仓库当前行为一致时,可使用此技能。
方式:该技能以子代理驱动,扮演文档负责人角色。必须生成一个子代理,由它读取仓库并返回结构化的“文档简报”以及可直接粘贴的 Markdown 内容。推荐的子代理提示词中要求:每一项安装步骤和命令都应基于仓库中确实存在的文件;优先采用最简单的可用路径,避免猜测功能;若仓库有多个运行时,只记录该仓库实际使用的那个;术语保持一致,少用行话。
主要能力:子代理需从仓库中提取项目身份、运行方式、使用流程、扩展方式和故障排查信息,并按需产出 README.md、docs/integration.md、docs/tutorial.md、docs/product.md、docs/faq.md、docs/troubleshooting.md 等文档。每份文档应包含项目是什么、面向谁、如何安装运行使用、验证步骤以及已知限制。
输出与限制:交付格式包括 Docs Brief、完整 README.md,以及必要时附加文档。质量要求包括命令目录正确、不引用不存在的文件、示例符合仓库约定、章节易于快速浏览。资料未提供具体安装命令、环境变量、平台或版本约束等事实,实际内容需由子代理从仓库中提取后确定。