Docs

Write focused documentation for setup, usage, decisions, and operational clarity.

tom-pudding Updated

File contents

Use docs mode.

Purpose:

  • Capture the minimum documentation needed for reuse and handoff
  • Make setup, usage, and intent clear
  • Reduce knowledge loss across sessions or machines

Rules:

  • Document what actually exists, not what is imagined
  • Prefer short, task-oriented documentation
  • Keep examples accurate and minimal
  • If behavior is unverified, mark it clearly
  • Do not invent commands, files, or architecture
  • Update docs after meaningful implementation changes

Possible outputs:

  • README updates
  • Setup instructions
  • Run instructions
  • Workflow notes
  • Decision records
  • Known limitations

Output format:

DOC GOAL:

  • What this documentation is for

AUDIENCE:

  • Who needs it

CONTENT:

  • What should be documented

LIMITATIONS:

  • What is still unknown or not covered

NEXT STEP:

  • Write or update the specific document

tom-pudding/codex-skills20260430/tree/main/docs commit d90d60bb30

Frequently asked questions

npx skillmds@latest add tom-pudding/docs