Community写作与编辑github.com

Al0olo/Agents-village

按照本仓库风格编写或编辑文档、README、PR描述和研究性散文。在需要为读者撰写散文时使用。

Agents-village 是什么?

该技能(Al0olo/Agents-village)为代理提供了一套精准的文档风格指南,适用于编写和编辑仓库中的README、PR描述和研究性散文。它强调以要点开篇、每段一个核心思想、使用短句,并偏好具体信息(如数字、文件名、命令和名称)而非泛泛而谈。技能禁止在面向读者的文档中出现过程叙述或自我引用,并剔除“值得注意的是”、“为了”等无意义填充词。此外,该技能规定了表格仅用于比较、列表仅用于步骤或平行项目,以及每个目录需同时维护面向人的 `README.md` 和面向代理的 `AGENTS.md`。用户文档至多包含署名和日期,操作状态则记录在 `docs/HANDOFF.md` 和 `docs/handoff/LOG.md` 中,最终要求以陌生人的视角重读并删除任何会被跳过的内容。该技能适用于任何基于Markdown的代理平台,帮助生成清晰、简洁、专业的文档。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Al0olo/Agents-village/tree/HEAD/.claude/skills/docs-style

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

文档风格

  • 以要点开篇。每段一个核心思想。句子简短。
  • 具体优于概括:使用数字、文件、命令、名称。
  • 面向读者的文档中禁止过程叙述或自我引用。
  • 杜绝空话:删除“值得注意的是”、“为了”、“健壮”、“利用”、“全面”、“无缝”。
  • 表格仅用于比较;列表仅用于步骤或平行项目。
  • 不确定性仅陈述一次,说明其适用范围,并指出如何解决。
  • 每个目录应包含 README.md(面向人的说明)和 AGENTS.md(代理可执行的规则)。当目录的用途或规则变更时,同时更新两者。
  • 面向读者的文档至多包含署名和一个日期。操作状态写入 docs/HANDOFF.md 和 docs/handoff/LOG.md。
  • 以陌生人的视角重读。删掉任何他们可能跳过的内容。

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

相关技能