Documentation should be written from the perspective of its intended audience, using language and detail levels appropriate for that audience. Focus on what matters most to the reader rather than technical implementation details.
Documentation should be written from the perspective of its intended audience, using language and detail levels appropriate for that audience. Focus on what matters most to the reader rather than technical implementation details.
For user-facing documentation (changelogs, READMEs, FAQs):
For developer documentation:
Example from changelog entries:
❌ Technical: "Shell initialization on macOS to manually check the ~/.hushlogin file"
✅ User-focused: "Hide login message if ~/.hushlogin is present"
❌ Vague: "could be easily done by user"
✅ Precise: "can be done outside of alacritty_terminal"
This approach ensures documentation serves its intended purpose by meeting readers where they are and providing the information they actually need.
Enter the URL of a public GitHub repository