business-readme

Installation
SKILL.md

Business README

Quick start

  1. 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.
  2. 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.
  3. Update README.md so business rules come first in human language, then technical execution instructions.
  4. Create or update docs/LLM_CONTEXT.md with only non-inferable context: rule pointers, real endpoints/operations, uncertainties, and durable gotchas. If the root-level docs/ directory does not exist, create it first.
  5. 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.

README structure

Installs
18
Repository
eaedave/skills
GitHub Stars
1
First Seen
Jun 9, 2026
business-readme — eaedave/skills