Use specific and clear language in all documentation to improve user understanding and avoid ambiguity. Favor precise terminology over vague descriptors, while balancing specificity with maintainability concerns.
Use specific and clear language in all documentation to improve user understanding and avoid ambiguity. Favor precise terminology over vague descriptors, while balancing specificity with maintainability concerns.
Examples:
<strong>
instead of <b>
)<!-- Instead of this -->
<p>
This documentation describes <b>the old</b> Vite version. For the latest
version, see <a href="https://vite.dev/">the latest document</a>.
</p>
<!-- Use this -->
<p>
This documentation covers Vite 5 <strong>(old version)</strong>. For the latest
version, see <a href="https://vite.dev">https://vite.dev</a>.
</p>
Consider the maintenance implications when determining how specific to be. Sometimes very precise details (like future version numbers) might create maintenance burden that outweighs the benefit of specificity.
Enter the URL of a public GitHub repository