skills/smithery.ai/docs-policy

docs-policy

Installation
SKILL.md

Documentation Policy

When to use

  • Adding a new feature doc in docs/ or component directories
  • Updating behavior that is already documented
  • Reviewing a PR that includes docs changes

Core rules

  • Prefer updating an existing component README.md over creating a new doc.
  • Create a dedicated doc only when it captures:
    • Cross-component behavior
    • Operational nuance / manual steps
    • Non-trivial reasoning (algorithms, SQL patterns, race-condition mitigations)
    • Recovery / rollback guidance
  • Place the doc next to the code it describes (backend docs in backend/, plugin docs in infra/plugin/, etc.).
  • Keep docs reproducible today; do not include secrets.
Installs
1
First Seen
Mar 23, 2026
docs-policy from smithery.ai