AGENTS.md 与 RUNBOOK.md 安全生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/generate-and-safely-patch-agents-md-and-runbook-md-with-agents-md-generator 到 AI 助手。
技能介绍
具体要解决的问题
在由编码代理维护的仓库里,AGENTS.md 与 RUNBOOK.md 经常是“机器契约”和“人类速查表”的混合体:前者给编码代理读取项目约定,后者给人快速查命令和运行方式。问题在于,一旦有人手工补充一段环境说明、目录约定或故障处理步骤,简单生成器再跑一次就可能整文件覆盖,把人工修改清掉。结果不是文档失效,而是代理读到的契约和团队实际维护的文档逐渐漂移。
技能如何工作
这个技能围绕 agentsgen 提供安全生成与修补路径。核心目标不是“重新生成一份漂亮的说明”,而是在初始化或更新时保留已有手工编辑内容,让仓库继续保留清晰的 机器可读契约。典型流程是先确认仓库与环境,再选择预设生成基础内容,例如 agentsgen init . --preset cli-python 对应 CLI/Python 场景;随后将 RUNBOOK.md 作为人类友好的命令/运行 cheatsheet 维护。对 Python library 场景,资料指向 recipes/python-lib/,即 Poetry + pytest 工作流。
适用边界与注意点
它适用于已经把仓库交给编码代理、同时需要维护 AGENTS.md 和 RUNBOOK.md 的工程团队,并且要求 Python 3.11+、pipx/pip 以及 Git 仓库。不要把该技能当作能凭空理解项目语义的文档生成器:上游只提供安全生成和修补的入口,具体约束仍来自项目 pyproject.toml 等声明。不同环境应使用匹配的上游安装/setup 路径;使用前要核对上游 requirements 与 caveats。若团队已有大量手工文档,建议先纳入版本控制,再让生成/修补流程运行,以便在冲突时回溯。文档细节以上游仓库和提取的 README 为准。
使用场景
- 仓库已有手工维护的 AGENTS.md,想安全更新项目约定而不覆盖人工补充内容
- Python CLI 项目需要为编码代理补一份 RUNBOOK.md 命令速查表
- Python library 项目在 Poetry + pytest 下生成代理可读的 AGENTS.md 契约
- 团队担心重复生成文档会冲掉已人工编辑的故障处理说明,需要先安全修补再提交
适合人员
- 负责仓库治理的后端工程师,希望代理契约不覆盖人工文档
- 带编码代理协作的技术负责人,需要把 CLI 运行命令沉淀进 RUNBOOK.md
- Python library 项目维护者,要在 Poetry + pytest 下生成代理约定
- 对自动化文档修补有顾虑的开发者,想先验证安全更新路径再采用