Docs

Create or update project documentation, setup guides, architecture notes, CLAUDE.md, runbooks, and developer-facing references.

arogyareddy Updated 3 repo stars

File contents

Docs

Use this when code changes affect setup, usage, workflows, architecture, testing, or team conventions.

Workflow

  1. Identify what changed and who needs to know.
  2. Update the nearest documentation to the change.
  3. Prefer concise, task-oriented documentation.
  4. Include commands, assumptions, and examples.
  5. Keep docs synchronized with the codebase.

Priority files

  • README.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • docs/architecture/*.md
  • testing or runbook docs

Output format

  • Files to update
  • Exact sections to add or revise
  • Gaps still undocumented

arogyareddy/scwa-framework commit 7570c7d9fc

Frequently asked questions

npx get-skill add arogyareddy/docs