New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Documentation Standards

by pr-pm in pr-pm/prpm

Standards and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository - ensures consistency across user docs, development docs, and internal references

MITAuto-check passedDevelopment

Install Documentation Standards

skills CLI
$ npx skills add pr-pm/prpm --skill documentation-standards -a claude-code

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

GitHub CLI
$ gh skill install pr-pm/prpm documentation-standards --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/pr-pm/prpm.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/documentation-standards .claude/skills/documentation-standards && 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-standards
GitHub stars
122
Token cost
~1.8k tokens
SKILL.md length
519 words
Files
1
Skills in repo
35
Repo updated
First seen
Licence
MIT

At a glance

Standards and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository - ensures consistency across user docs, development docs, and internal references

  • Works in 6 steps: ✅ Move file to correct location → ✅ Update all references to moved file → ✅ Update README.md links if needed → …
  • Development work in your project
  • SKILL.md covers Documentation Organization, Rules for Documentation…, Documentation Standards and Migration Checklist, plus 6 more sections
  • Calls npm

What it does

Documentation Standards is an agent skill from pr-pm/prpm. Standards and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository - ensures consistency across user docs, development docs, and internal references

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development. It works with GitHub Actions. The repository describes itself as: The universal registry for AI coding tools. The licence is MIT.

When your agent uses it

  • Development work in your project

Example prompts

  • “Use the documentation-standards skill to standard and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository -…”
  • “/documentation-standards”

Requirements

  • Docker

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. ✅ Move file to correct location
  2. ✅ Update all references to moved file
  3. ✅ Update README.md links if needed
  4. ✅ Update .gitignore if needed
  5. ✅ Test that all links work
  6. ✅ Commit with clear message explaining move

What it can do on your machine

Read from SKILL.md and the folder at commit 5f993e6. 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

    Shell commands in SKILL.md call:

    • npm

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

  • Network

    No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.

    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 Standards loads about 1.8k tokens when it runs. Until then it costs about 53 tokens; SKILL.md has 519 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~53
When it runs · the whole SKILL.md, loaded when a task matches
~1.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

The full file from pr-pm/prpm at commit 5f993e6, republished under its MIT licence (© pr-pm). 519 words, ~1,805 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-standards/SKILL.md (or your agent's skills folder).
name
documentation-standards
description
Standards and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository - ensures consistency across user docs, development docs, and internal references

PRPM Documentation Standards

Documentation Organization

Internal Documentation (development/docs/)

Purpose: Documentation for developers working on PRPM itself

Location: development/docs/

Files:

  • GITHUB_WORKFLOWS.md - GitHub Actions workflows reference
  • PUBLISHING.md - NPM package publishing process and order
  • DEVELOPMENT.md - Development setup, environment, and workflows
  • DOCKER.md - Docker setup, services, and troubleshooting

Audience: PRPM contributors, maintainers, CI/CD systems

User-Facing Documentation (docs/)

Purpose: Documentation for PRPM users and package authors

Location: docs/ (at project root)

Files:

  • User guides
  • API documentation
  • Package authoring guides
  • CLI command reference
  • Examples and tutorials

Audience: PRPM end users, package authors, integrators

Project-Level Documentation (root)

Purpose: Standard project files that belong at repository root

Location: Project root /

Files:

  • README.md - Project overview, quick start, installation
  • CONTRIBUTING.md - Contribution guidelines
  • CHANGELOG.md - Version history and changes
  • LICENSE - License information
  • ROADMAP.md - Project roadmap and future plans

Audience: Everyone (first impression)

Claude Skills (.claude/skills/)

Purpose: Knowledge base and reference materials for AI assistants

Location: .claude/skills/

Files:

  • postgres-migrations-skill.md - PostgreSQL migrations guidance
  • pulumi-troubleshooting-skill.md - Pulumi troubleshooting
  • NEW_SKILLS.md - How to create new skills
  • documentation-standards.md - This file

Subdirectories:

  • prpm-development/ - PRPM-specific development knowledge
  • self-improving/ - Self-improvement patterns
  • thoroughness/ - Thoroughness and quality guidelines

Audience: AI assistants (Claude, etc.)

Rules for Documentation Placement

When to use development/docs/

✅ GitHub Actions workflows and CI/CD ✅ Internal build/release processes ✅ Development environment setup ✅ Architecture decision records ✅ Internal troubleshooting guides ✅ Database schema documentation ✅ Infrastructure documentation

❌ User-facing tutorials ❌ CLI usage guides ❌ API reference for end users

When to use docs/

✅ User guides and tutorials ✅ CLI command reference ✅ Package authoring guides ✅ API documentation for users ✅ Integration examples ✅ FAQ for users

❌ Internal development workflows ❌ CI/CD documentation ❌ Build/release processes

When to use .claude/skills/

✅ Specialized knowledge for AI assistants ✅ Domain-specific best practices ✅ Troubleshooting patterns ✅ Code review guidelines ✅ Project-specific conventions

❌ General documentation ❌ User guides ❌ API references

Documentation Standards

Markdown Files
  • Use clear, descriptive filenames (kebab-case)
  • Include table of contents for docs > 200 lines
  • Use proper heading hierarchy (# → ## → ###)
  • Include code examples with syntax highlighting
  • Add frontmatter if using a static site generator
Example Structure
markdown
# Title

Brief description (1-2 sentences)

## Table of Contents
- [Section 1](#section-1)
- [Section 2](#section-2)

## Section 1
Content...

### Subsection 1.1
Details...

## Examples
\`\`\`bash
# Example command
prpm install @username/package-name
\`\`\`

## See Also
- [Related Doc](./related.md)
Show full SKILL.md (209 more words)Show less
Cross-References
  • Use relative paths for links
  • Keep links within same category when possible
  • Update links when moving files

Internal → Internal:

markdown
See [Publishing Guide](./PUBLISHING.md)

Internal → User:

markdown
See [User Guide](../../docs/user-guide.md)

Migration Checklist

When reorganizing documentation:

  1. ✅ Move file to correct location
  2. ✅ Update all references to moved file
  3. ✅ Update README.md links if needed
  4. ✅ Update .gitignore if needed
  5. ✅ Test that all links work
  6. ✅ Commit with clear message explaining move

Package-Specific Documentation

Each package should have its own README:

packages/
├── cli/
│   └── README.md          # CLI package overview
├── registry/
│   └── README.md          # Registry server docs
├── registry-client/
│   └── README.md          # Client library docs
├── types/
│   └── README.md          # Type definitions docs
└── webapp/
    └── README.md          # WebApp docs

Maintenance

Regular Reviews
  • Quarterly review of docs/ for accuracy
  • Remove outdated documentation
  • Update examples to use latest version
  • Check for broken links
When Adding Features
  • Update relevant user docs in docs/
  • Update internal docs in development/docs/ if needed
  • Add examples
  • Update CHANGELOG.md
When Deprecating Features
  • Add deprecation notice to docs
  • Provide migration guide
  • Keep docs until feature is removed
  • Update CHANGELOG.md

Quick Reference

Documentation TypeLocationAudienceExamples
Internal Devdevelopment/docs/ContributorsCI/CD, publishing
User-Facingdocs/UsersGuides, tutorials
Project Root/EveryoneREADME, LICENSE
AI Skills.claude/skills/AI assistantsTroubleshooting
Package Docspackages/*/README.mdPackage usersAPI reference

Tools

Documentation Generators
  • TypeDoc - For TypeScript API docs (future)
  • VitePress or Docusaurus - For docs/ site (future)
Linting
bash
# Check markdown
markdownlint docs/

# Check links
markdown-link-check docs/**/*.md
Building Docs Site (Future)
bash
cd docs/
npm run build

Examples

Good Documentation Structure
prpm/
├── README.md                    # Project overview
├── CONTRIBUTING.md              # How to contribute
├── CHANGELOG.md                 # Version history
├── ROADMAP.md                   # Future plans
├── development/
│   └── docs/
│       ├── GITHUB_WORKFLOWS.md  # CI/CD reference
│       ├── PUBLISHING.md        # Release process
│       ├── DEVELOPMENT.md       # Dev setup
│       └── DOCKER.md            # Services setup
├── docs/
│   ├── getting-started.md       # User onboarding
│   ├── cli-reference.md         # Command reference
│   ├── package-authoring.md     # Creating packages
│   └── api/
│       └── registry-client.md   # API docs
└── .claude/
    └── skills/
        ├── documentation-standards.md
        ├── postgres-migrations-skill.md
        └── pulumi-troubleshooting-skill.md
Bad Documentation Structure ❌
prpm/
├── README.md
├── WORKFLOWS.md                 # Should be in development/docs/
├── USER_GUIDE.md                # Should be in docs/
├── dev-setup.md                 # Should be in development/docs/
└── troubleshooting.md           # Unclear audience/location

Version

Last Updated: 2025-10-21 Applies To: PRPM v2+ Review Date: 2026-01-21

© pr-pm, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/documentation-standards of pr-pm/prpm.

Open the folder on GitHubat commit 5f993e6

Compare with similar skills

Documentation Standards 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 Standards compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Standards this skillpr-pm/prpm122—~1.8kAutomated safety check: PassMIT
Babysit PR To Pass CIsgl-project/sglang37k2 repos~3kAutomated safety check: PassApache-2.0
Cline Desktop App Releasecline/cline70k—~4.5kAutomated safety check: PassApache-2.0
ReleaseXGHeaven/homebox817—~1.4kAutomated safety check: PassNone
ZCF Release AutomationUfoMiao/zcf6.1k—~3.4kAutomated safety check: PassMIT
Renovate Actions PR Reviewbacknotprop/plannotator9.2k—~640Automated safety check: PassApache-2.0

Similar skills

  • Babysit PR To Pass CI

    sgl-project/sglang

    Start and persistently pursue a goal to babysit an SGLang pull request until selected GitHub Actions workflows pass on the latest PR head.

    37k GitHub starsUsed in 2 repos~3k tokens
    DevelopmentAuto-check passed

  • Cline Desktop App Release

    cline/cline

    Covers preparing, tagging and publishing a Cline desktop app release on the stable, beta or nightly channel through the desktop-publish GitHub workflow.

    70k GitHub stars~4.5k tokensUpdated today
    DevelopmentAuto-check passed

  • Release

    XGHeaven/homebox

    Prepare, verify, and publish Homebox releases through the repository's tag-driven GitHub Actions workflow.

    817 GitHub stars~1.4k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

  • ZCF Release Automation

    UfoMiao/zcf

    Automates a version release with changesets: analyzes code changes, writes a bilingual CHANGELOG, bumps the version and commits through a release branch and pull request.

    6.1k GitHub stars~3.4k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

  • Renovate Actions PR Review

    backnotprop/plannotator

    Reviews Renovate pull requests that bump GitHub Actions by checking pinned SHAs against upstream tags, scanning changelogs and confirming workflows stay compatible.

    9.2k GitHub stars~640 tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Cline CLI Release Publisher

    cline/cline

    Walks through releasing the Cline CLI package to npm: release notes, version bump, matching git tag, and either the GitHub workflow or a local publish.

    70k GitHub stars~3.4k tokensUpdated today
    DevelopmentAuto-check: warnings

More from pr-pm/prpm

All 35 skills in this repo

  • Creating Claude Code Agents

    pr-pm/prpm

    Reference for writing Claude Code agent files: location, frontmatter fields, validation limits, tool and model choices, and the required content format.

    122 GitHub starsUsed in 3 repos~4k tokens
    Auto-check passed

  • Creating Claude Code Hooks

    pr-pm/prpm

    Covers how to build, configure and publish Claude Code hooks: event types, exit codes, JSON I/O, and PRPM packaging.

    122 GitHub starsUsed in 2 repos~3.9k tokens
    Auto-check: notes

  • Creating Claude Rules Files

    pr-pm/prpm

    Shows how to write .claude/rules/ files correctly: paths frontmatter instead of globs, quoted glob patterns, global rules and conversion of Cursor rules.

    122 GitHub starsUsed in 2 repos~551 tokens
    Auto-check passed

  • Creating Agent Skills Packages

    pr-pm/prpm

    Reference for writing portable Agent Skills packages, covering SKILL.md frontmatter limits, name rules, directory layout and where Codex CLI, GitHub Copilot and Amp look for skills.

    122 GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed

  • Creating Kiro Agents

    pr-pm/prpm

    A skill your agent uses when building custom Kiro AI agents or when user asks for agent configurations - provides JSON structure, tool configuration, prompt patterns, and security best practices for…

    122 GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed

  • Creating Opencode Agents

    pr-pm/prpm

    A skill your agent uses when creating OpenCode agents - provides markdown format with YAML frontmatter, mode/tools/permission configuration, and best practices for specialized AI assistants

    122 GitHub starsUsed in 1 repo~2k tokens
    Auto-check passed

Works with

Categories

Questions about Documentation Standards

What does Documentation Standards do?

Standards and guidelines for organizing, structuring, and maintaining documentation in the PRPM repository - ensures consistency across user docs, development docs, and internal references. Documentation Standards is an agent skill from pr-pm/prpm.

When should I use Documentation Standards?

Documentation Standards fits situations like: development work in your project.

How do I install Documentation Standards in Claude Code?

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

How do I install Documentation Standards in Codex?

Run `npx skills add pr-pm/prpm --skill documentation-standards -a codex`. Or copy the skill folder (.claude/skills/documentation-standards in pr-pm/prpm) into .agents/skills/documentation-standards in your project. Codex loads it when a task matches its description.

Can I use Documentation Standards 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 pr-pm/prpm --skill documentation-standards -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-standards, .gemini/skills/documentation-standards, .github/skills/documentation-standards and .opencode/skills/documentation-standards in your project.

What does Documentation Standards need to run?

Going by SKILL.md and its folder, Documentation Standards needs the command-line tools its instructions call (npm). Our summary lists: Docker.

Does Documentation Standards access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Documentation Standards 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 Standards use?

Documentation Standards is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Standards use?

About 1.8k tokens (SKILL.md is roughly 7.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation Standards?

Skills that share tags, products or a category with Documentation Standards: Babysit PR To Pass CI (sgl-project/sglang, 37k stars), Cline Desktop App Release (cline/cline, 70k stars), Release (XGHeaven/homebox, 817 stars) and ZCF Release Automation (UfoMiao/zcf, 6.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Standards?

pr-pm (a GitHub organization) maintains it in pr-pm/prpm, which has 122 GitHub stars. The repository holds 35 skills in this directory. The repository was last updated on October 6, 2026.

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