Agent skill

Documentation Conventions

by eser in eser/stack

Covers package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail preservation, where docs live, docs that change with the code, and no empty qualifiers, unbacked…

Custom licenceAuto-check passedDevelopment

Install Documentation Conventions

skills CLI
$ npx skills add eser/stack --skill documentation-conventions -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install eser/stack documentation-conventions --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/eser/stack.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation-conventions .claude/skills/documentation-conventions && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-conventions
GitHub stars
128
Token cost
~410 tokens
SKILL.md length
135 words
Files
4 (incl. references)
Skills in repo
13
Repo updated
First seen
Licence
Custom licence

At a glance

Covers package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail preservation, where docs live, docs that change with the code, and no empty qualifiers, unbacked…

  • Editing READMEs
  • SKILL.md covers Always and References
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Changelog entries

What it does

Documentation Conventions is an agent skill from eser/stack. Covers package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail preservation, where docs live, docs that change with the code, and no empty qualifiers, unbacked claims, em dashes or generated rhythm. Use when writing or editing READMEs, docs, skill files, ADR text, backlog items, changelog entries, commit messages or code comments.

Its SKILL.md is about 410 tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `evals/triggers.json`, `references/prose.md` and `references/readmes.md`).

It sits in Development, covering Technical documentation, Commit messages and Architecture decision records. The repository describes itself as: The Portability Solution for Your Code! 🚀 Powered By Deno and JavaScript.

When your agent uses it

  • Editing READMEs
  • Changelog entries
  • Commit messages

Example prompts

  • “Use the documentation-conventions skill to cover package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail…”
  • “/documentation-conventions”

What it can do on your machine

Read from SKILL.md and the folder at commit 64939e6. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Conventions loads about 410 tokens when it runs, and up to ~3.8k if it reads all its reference files. Until then it costs about 99 tokens; SKILL.md has 135 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~99
When it runs · the whole SKILL.md, loaded when a task matches
~410
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 135 words (~410 tokens).

“Rules for what the repository's documents say and how they say it.”

— opening of SKILL.md by eser, Custom licence
name
documentation-conventions

Read the full SKILL.md on GitHub

Files

SKILL.md and 3 other files (references) in .agents/skills/documentation-conventions of eser/stack.

  • SKILL.md
  • evals/triggers.json
  • references/prose.md
  • references/readmes.md

Open the folder on GitHubat commit 64939e6

Compare with similar skills

Documentation Conventions next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Conventions compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Conventions this skilleser/stack128—~410Automated safety check: PassCustom licence
Prosestatic-web-server/static-web-server2.4k—~971Automated safety check: PassApache-2.0
Agent Stylepchalasani/claude-code-tools2k—~1.4kAutomated safety check: PassMIT
Documentationaiskillstore/marketplace4301 repos~2.7kAutomated safety check: PassNone
Swig Conventionsswig/swig6.3k—~2.7kAutomated safety check: PassCustom licence
Docsbrickbots/PiFinder250—~6.2kAutomated safety check: PassGPL-3.0

Similar skills

  • Prose

    static-web-server/static-web-server

    Author or edit any prose for the Static Web Server (SWS) project — documentation, design docs, READMEs, PR descriptions, issue bodies, commit message bodies, or other human-readable text — following…

    2.4k GitHub stars~971 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Agent Style

    pchalasani/claude-code-tools

    Literature-backed English technical-prose writing rules (agent-style, 21 rules).

    2k GitHub stars~1.4k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Documentation

    aiskillstore/marketplace

    Comprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation.

    430 GitHub starsUsed in 1 repo~2.7k tokens
    DevelopmentAuto-check passed
  • SWIG source and contribution conventions: clang-format / code formatting, C/C++ comment style (quotes, widths, function header blocks), parser.y new-code rules, alphabetical ordering of makefile…

    6.3k GitHub stars~2.7k tokensUpdated today
    DevelopmentAuto-check passed
  • Docs

    brickbots/PiFinder

    Author and edit PiFinder's user-facing documentation in the project's house style.

    250 GitHub stars~6.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Plain Writing

    docwriter-org/plain-writing-skill

    Writes and edits prose in a plain and boring style: simple everyday words, complete sentences, no dashes, no jargon, and no analogies.

    461 GitHub stars~3.6k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from eser/stack

All 13 skills in this repo
  • Picks the skills a task needs and maintains the rules in .agents/skills.

    128 GitHub stars~749 tokensUpdated 3 days ago
    Auto-check passed
  • System design in eserstack: double-layered hexagonal architecture, explicit adapter composition, public API and CLI surface, request metadata, testing strategy, ADRs.

    128 GitHub stars~516 tokensUpdated 3 days ago
    Auto-check passed
  • Language-neutral code quality rules for eserstack, TypeScript and Go.

    128 GitHub stars~688 tokensUpdated 3 days ago
    Auto-check passed
  • Enrichment

    eser/stack

    Interviews the user about a plan, decision or idea in rounds, level by level down a decision tree, until both share one understanding; facts are researched by sub-agents, decisions stay with the user.

    128 GitHub stars~642 tokensUpdated 3 days ago
    Auto-check passed
  • Go Practices

    eser/stack

    Go conventions for eserstack's ajan framework, services and FFI bridge.

    128 GitHub stars~851 tokensUpdated 3 days ago
    Auto-check passed
  • TS and JS conventions for eserstack packages: namespace imports, mod.ts entries, cross-runtime APIs, explicit checks, async, tests and laroux React components.

    128 GitHub stars~599 tokensUpdated 3 days ago
    Auto-check passed

Categories

Questions about Documentation Conventions

What does Documentation Conventions do?

Covers package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail preservation, where docs live, docs that change with the code, and no empty qualifiers, unbacked…. Documentation Conventions is an agent skill from eser/stack. Covers package READMEs, project docs and plain prose: namespace imports in examples, emoji and detail preservation, where docs live, docs that change with the code, and no empty qualifiers, unbacked claims, em dashes or generated rhythm.

When should I use Documentation Conventions?

Documentation Conventions fits situations like: editing READMEs; changelog entries; commit messages.

How do I install Documentation Conventions in Claude Code?

Run `npx skills add eser/stack --skill documentation-conventions -a claude-code`. Or copy the skill folder (.agents/skills/documentation-conventions in eser/stack) into .claude/skills/documentation-conventions in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Conventions in Codex?

Run `npx skills add eser/stack --skill documentation-conventions -a codex`. Or copy the skill folder (.agents/skills/documentation-conventions in eser/stack) into .agents/skills/documentation-conventions in your project. Codex loads it when a task matches its description.

Can I use Documentation Conventions in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add eser/stack --skill documentation-conventions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-conventions, .gemini/skills/documentation-conventions, .github/skills/documentation-conventions and .opencode/skills/documentation-conventions in your project.

What does Documentation Conventions need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation Conventions is instructions for the agent only.

Does Documentation Conventions access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation Conventions safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Conventions use?

Documentation Conventions has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Documentation Conventions use?

About 410 tokens (SKILL.md is roughly 1.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 3.4k tokens, read only when the agent opens those files.

What are the alternatives to Documentation Conventions?

Skills that share tags, products or a category with Documentation Conventions: Prose (static-web-server/static-web-server, 2.4k stars), Agent Style (pchalasani/claude-code-tools, 2k stars), Documentation (aiskillstore/marketplace, 430 stars) and Swig Conventions (swig/swig, 6.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Conventions?

eser (a GitHub user) maintains it in eser/stack, which has 128 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on October 3, 2026.

Source: eser/stack on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.