docs-style

Clear technical documentation requires active voice, conciseness, consistent terminology, and clear headings to ensure optimal readability for both humans and AI. Using second person directly addresses the reader effectively.

To make documentation LLM-friendly, state prerequisites clearly, define acronyms on first use, and provide complete code examples. Semantic markup and self-contained pages also significantly aid AI comprehension.

Yes, this documentation style guide applies to API references by ensuring all sections follow best practices for clarity, structure, and LLM interpretability, making the documentation more effective and maintainable.

Review existing technical writing for consistency by checking adherence to guidelines on active voice, conciseness, clear headings, semantic markup, and consistent terminology for optimal human and AI readability.

Semantic markup and self-contained pages in technical documentation improve usability and maintainability by ensuring clear structure and readability. This approach allows both humans and AI to navigate and understand content effectively.