doc-agent-file

星标5

分支0

更新时间2026年7月25日 13:21

编写、修改、审查或建议更新 AGENTS.md 时使用

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

shelken

shelken/nix-config

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

AGENTS.md 的基本格式要求

开头介绍项目基本/核心功能, 用一句话描述最核心
通用性：当前范围下的其他代码也适用，且后续大概率会再次用到
只记录重要、非一次性的项目约定和约束; 如果代码已经可以说明问题, 不要记录到 AGENTS.md 中
不记录一次性任务背景、临时路径、普通 debug 过程
必须是项目相关的, 不要因为其他原因的错误也记录进项目中
按就近原则选择涉及范围内最近的已存在 AGENTS.md；否则使用项目根目录 AGENTS.md
使用二级标题分组，标题下通常用无序列表
重点写开发注意事项/基本约束, 如果有功能描述, 去掉(功能介绍放README)
有 基本约束 块(or 项目规范), 负责描述日常开发行为规范, 必须由用户确认后才能进入, AGENT 只能提供建议; 当用户提出重要的有关项目的约束时, 展示建议写入的文本并询问是否记录; 建议时 永远不要提出已经在代码体现的内容; 建议内容必须是项目相关而非 工具相关
有基本的目录结构指引, 不要精确到文件, 而是到目录; 项目根目录重要文件可以例外; 格式为<path>: <一句话简短介绍>
每次阅读到项目AGENTS.md时, 如果不符合格式要求, 在用户的任务结束前或者代码提交前询问用户是否调整, 并给出建议

同仓库更多 Skills

同仓库

docs-policy

shelken/nix-config

编写、修改项目文档，或需要统一文档约定时使用

2026-07-255

git-workflow

shelken/nix-config

Git 提交、GitHub 日常操作或提交前文档检查时使用

2026-07-255

project-memory

shelken/nix-config

管理项目长期知识，支持 recall、capture、mine、audit 四种模式。用于搜索 Pi 当前或历史 Session、回忆过去决策、从开发过程提炼可复用经验、更新 AGENTS 或项目 Skill、形成 ADR/Postmortem 候选，以及检查项目知识是否过时、重复、冲突或放错位置。跨 Session 检索依赖本机安装的 project-memory CLI（Bun/TS）

发起、审查或规划子代理工作时使用

当用户需要写README时使用;当需要满足用户对readme文档的要求时使用

2026-07-255

doc-user-guide

shelken/nix-config

当用户需要写用户指南时使用;当需要满足用户对用户指南的要求时使用

2026-07-255

name	doc-agent-file
description	编写、修改、审查或建议更新 AGENTS.md 时使用

AGENTS.md 的基本格式要求

开头介绍项目基本/核心功能, 用一句话描述最核心
通用性：当前范围下的其他代码也适用，且后续大概率会再次用到
只记录重要、非一次性的项目约定和约束; 如果代码已经可以说明问题, 不要记录到 AGENTS.md 中
不记录一次性任务背景、临时路径、普通 debug 过程
必须是项目相关的, 不要因为其他原因的错误也记录进项目中
按就近原则选择涉及范围内最近的已存在 AGENTS.md；否则使用项目根目录 AGENTS.md
使用二级标题分组，标题下通常用无序列表
重点写开发注意事项/基本约束, 如果有功能描述, 去掉(功能介绍放README)
有 基本约束 块(or 项目规范), 负责描述日常开发行为规范, 必须由用户确认后才能进入, AGENT 只能提供建议; 当用户提出重要的有关项目的约束时, 展示建议写入的文本并询问是否记录; 建议时 永远不要提出已经在代码体现的内容; 建议内容必须是项目相关而非 工具相关
有基本的目录结构指引, 不要精确到文件, 而是到目录; 项目根目录重要文件可以例外; 格式为<path>: <一句话简短介绍>
每次阅读到项目AGENTS.md时, 如果不符合格式要求, 在用户的任务结束前或者代码提交前询问用户是否调整, 并给出建议