documentation-standards

A guide to organizing and maintaining documentation in the PRPM repository, with separate locations for user guides, contributor information, and internal development notes.

In plain words
What is it for?
It helps decide where to add guides, API references, tutorials, project setup notes, publishing instructions, Docker documentation, and other repository records.
Why use it?
It helps contributors put information in the right place and keep documentation consistent for users, package authors, and maintainers.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/pr-pm/prpm/documentation-standards
Any agent
npx skills add pr-pm/prpm --skill documentation-standards
Clone the repo
git clone --depth 1 https://github.com/pr-pm/prpm

Made for: Claude Code, Codex.

Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,733 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00036 $0.01733
Opus 5 $0.00018 $0.00866
Sonnet 5 $0.00007 $0.00347
Haiku 4.5 $0.00004 $0.00173

Measured 3d ago against content hash 9e0dac1ef1bb, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-standards scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/skills/documentation-standards/SKILL.md · 304 lines

How it starts

The opening of the file, as written. The whole thing — 304 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

Read the full file on GitHub · 304 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 304 lines · 36 tokens per session scan A 9e0dac1ef1bb

Subscribe to this mod's changes

documentation-standards is a skill published in the GitHub repository pr-pm/prpm (120 stars, last pushed 2mo ago), licensed MIT. It adds 36 tokens to every session and 1,733 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.