Ensure consistent terminology, precise language, and uniform formatting throughout all documentation to improve clarity and user experience. Use standardized terms consistently (e.g., "V1" and "V2" not "v1" and "v2"), choose precise wording that clearly conveys intent, and maintain consistent formatting patterns.
Ensure consistent terminology, precise language, and uniform formatting throughout all documentation to improve clarity and user experience. Use standardized terms consistently (e.g., “V1” and “V2” not “v1” and “v2”), choose precise wording that clearly conveys intent, and maintain consistent formatting patterns.
Key practices:
Example of consistent terminology:
# Good
Pull requests must be cleanly rebased on top of the base branch without multiple branches
# Avoid
Pull requests must be cleanly rebased on top of master without multiple branches
Example of precise language:
# Good
4. Include code comments. Tell us the why, the history and the context.
# Avoid
4. Comment on the code. Tell us the why, the history and the context.
This consistency reduces confusion, improves maintainability, and creates a more professional user experience across all documentation.
Enter the URL of a public GitHub repository