egeetas Documentation Style
Write for the reader's next action. Match the repository's established terminology and formatting before introducing a new convention.
Principles
- Lead with purpose, prerequisites, and the shortest successful path.
- Keep commands executable and examples internally consistent.
- Separate required steps from optional configuration and troubleshooting.
- Document public behavior, constraints, errors, side effects, security considerations, and compatibility where relevant.
- Use code comments to explain intent, invariants, or non-obvious trade-offs; do not narrate obvious syntax.
- Write changelog entries from the user's perspective and identify breaking changes explicitly.
- Never claim tests, compatibility, or behavior that was not verified.
After code changes, update only documentation made inaccurate or incomplete by the requested work. Validate links, commands, names, paths, and examples against the repository.