Documentation Style Guide

This Style Guide provides guidelines for writing documentation on our website. It ensures consistency and clarity across all our documentation.

General Guidelines

• Use Simple Language: Write in a clear, straightforward manner. Avoid technical jargon unless necessary.
• Be Concise: Keep sentences and paragraphs short and to the point.
• Consistency: Use consistent formatting and terminology throughout the documentation.

Formatting

• Headings: Use headings to structure your content. Make sure headings are descriptive and hierarchical.
• Lists: Use bullet points or numbered lists for items, steps, or examples.
• Emojis: Use emojis sparingly to add a touch of personality to the content.

Images

• Incorporate Visuals: Use images to illustrate concepts or provide examples. Ensure images are relevant and high-quality.

Links

• Internal Links: Include links to related documentation or pages within the website to provide additional information.
• External Links: Use external links to reference authoritative sources or external resources.

Example

Here's an example of how to format a section with a link and an image:

• Section Title

  • This is a brief description of the section.
  • Learn more
  

  Example Image

Conclusion

Following these guidelines will help create comprehensive and user-friendly documentation. For more information, visit our Documentation Home.