CommunityWriting & Editinggithub.com

Al0olo/Agents-village

Write or edit documentation, READMEs, PR descriptions and research prose in this repo's style. Use whenever producing prose meant for readers.

What is Agents-village?

Agents-village is a Claude Code agent skill that write or edit documentation, READMEs, PR descriptions and research prose in this repo's style. Use whenever producing prose meant for readers.

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

Installed? Explore more Writing & Editing skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Ask in your favorite AI

Open a new chat with this agent skill pre-loaded.

Documentation

Docs style

  • Lead with the point. One idea per paragraph. Short sentences.
  • Concrete over general: a number, a file, a command, a name.
  • No process narration or self-reference in reader-facing documents.
  • No padding: cut "it is important to note", "in order to", "robust", "leverage", "comprehensive", "seamless".
  • Tables only for comparison; lists only for steps or parallel items.
  • State uncertainty once, where it applies, and say what would resolve it.
  • Each directory has a README.md (what it is, for people) and an AGENTS.md (rules an agent can act on). Update both when the directory's purpose or rules change.
  • Reader-facing docs carry a byline and one date at most. Operational state goes in docs/HANDOFF.md and docs/handoff/LOG.md.
  • Read it back as a stranger. Cut anything they would skip.

Individual skills in this repo

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

Related Skills