warisskill-documentation-practices
Installation
SKILL.md
Documentation Practices
Standing rule (unchanged, this skill doesn't loosen it): never create a README or general project doc unless explicitly asked. API documentation is the one exception — it's generated automatically whenever an API exists, no request required. See below.
Depth: scale to audience, not a fixed default
- Solo/scratch project, nobody else will read it: minimal but complete — what it is, how to run it locally, key commands. A future-you refresher, not a pitch document.
- Meant for other people or clients: comprehensive — setup, a real explanation of how the system works (not just file listing), and deployment notes if the reader might need to deploy it themselves.
Ask which register applies if it's not obvious from context (a client deliverable vs a personal tool) rather than defaulting to either extreme.