Use precise, natural language in documentation to improve clarity and readability. Focus on accurate word choice, proper grammar, and natural phrasing that flows well for readers.
Key areas to address:
Word Choice Precision: Choose specific, accurate terms over vague ones:
Natural Phrasing: Write in a way that sounds natural when read aloud:
Grammar Accuracy: Pay attention to conjunctions and sentence structure:
Example improvements:
- This function can also return a Promise and a value
+ This function can be asynchronous
- Never combine next() callback with a legacy middleware that is async
+ Never combine the next() callback with an async legacy middleware
- We recommend to use useHead() in app.vue
+ We recommend using useHead() in app.vue
These language improvements make documentation more professional, easier to understand, and reduce cognitive load for developers reading the content.
Enter the URL of a public GitHub repository