business-readme
Installation
SKILL.md
Business README
Quick start
- Ask the output language before writing docs:
1. Português do Brasil,2. English, or custom typed language. If the user already answered in this conversation, use that. - Inspect the project context: README, docs, tests, routes/controllers/use-cases/domain models, schemas/migrations/seeds, config, examples, integration clients, real endpoints/operation names, and recent task context relevant to business behavior.
- Update
README.mdso business rules come first in human language, then technical execution instructions. - Create or update
docs/LLM_CONTEXT.mdwith only non-inferable context: rule pointers, real endpoints/operations, uncertainties, and durable gotchas. If the root-leveldocs/directory does not exist, create it first. - Run the validator script if available:
node <skill>/scripts/validate-business-readme.cjs <project-root>.
Source-of-truth policy
- Code and tests beat old docs when they disagree.
- Existing README text is evidence, not authority, unless the user says it is the contract.
- When code/tests/docs conflict, document observed behavior and record the conflict in
docs/LLM_CONTEXT.md. - Ask the user only when a rule is ambiguous, dangerous to infer, or requires choosing product intent instead of observed behavior.
- Never invent business rules. Mark unresolved items as explicit unknowns.