documentation-practices

Core approach

• Document what engineers and operators need to act.
• Prefer accuracy, concrete examples, and real workflows.
• Keep docs aligned with the actual system, commands, and file paths.
• Avoid documentation that is broad but operationally empty.

Practical guidance

• Focus on setup, usage, debugging, extension, release, and operational decision points.
• Update adjacent docs when behavior or workflow changes materially.