This style guide provides information on how to structure and present documentation on our website. It aims to ensure consistency, clarity, and usability across all our documentation.

Table of Contents

Introduction

Welcome to the Documentation Style Guide! This guide is designed to help writers and contributors create high-quality, user-friendly documentation. By following these guidelines, you'll ensure that our documentation is accessible, accurate, and informative.

Formatting

  • Headings: Use headings to structure your content. This makes it easier for users to navigate and find the information they need.
  • Lists: Use bullet points or numbered lists to present information in a clear, concise manner.
  • Emojis: Use emojis sparingly to add a touch of personality to your documentation.

Content Structure

  • Introduction: Start each section with an introduction that outlines what the section covers.
  • Examples: Provide examples where applicable to illustrate the concept or procedure.
  • Troubleshooting: Include a troubleshooting section to help users resolve common issues.

Language and Terminology

  • Consistency: Use consistent terminology throughout the documentation.
  • Clarity: Avoid jargon and explain technical terms clearly.
  • Language: Our documentation is available in multiple languages. Always use the appropriate language for your target audience.

Images and Media

  • Relevance: Use images and media to enhance understanding and engagement.
  • Quality: Ensure that images and media are of high quality and relevant to the content.
  • Alt Text: Provide alt text for all images to improve accessibility.

Links and References

  • Internal Links: Use internal links to direct users to related documentation.
  • External Links: Use external links sparingly and ensure they are relevant and reliable.

Feedback and Updates

  • Suggestions: We welcome feedback on our documentation. Use the feedback form linked below to suggest improvements.
  • Updates: Keep your documentation up to date with the latest information and changes.

For more information on documentation best practices, visit our Documentation Best Practices Guide.

Golden_Retriever