Writing Guidelines
Headings and Titles
Learn how to structure effective headings and titles for better readability, organization, and user engagement in technical documentation.
Paragraphs
Learn to craft concise, scannable paragraphs that enhance readability and user engagement in technical documentation.
Word and Acronym Usage
Master the principles of word usage and acronym handling in technical documentation to improve clarity, accessibility, and user engagement.
Hyperlinks
Learn best practices for creating informative, user-friendly, and SEO-optimized hyperlinks that enhance content usability and navigation.
Images and Screenshots
Guidelines for using images and screenshots in technical documentation, including sizing standards, callout specifications, and alt-text writing.
Lists (Ordered and Unordered)
Guidelines for using ordered and unordered lists in technical documentation, including structure, capitalization, punctuation, and introductory text.
Tips for AI-Generated Content
Guidelines for using AI-generated content in technical documentation, including best practices, style adherence, bias awareness, and common pitfalls.
Writing Effective Procedures
Guidelines for writing clear, concise procedures in technical documentation, including action verbs, step structure, context, and visuals.
UX Writing Tips for YAML Files
Actionable tips for engineers and developers to improve clarity, brevity, and effectiveness in YAML metadata inputs for catalog-info.yaml and template.yaml files, ensuring better understanding and usability across teams.
Writing Effective Error Messages
Guidelines for writing clear, actionable error messages, including severity levels, security considerations, and implementation best practices.