Skip to main content

Content Guidelines

Best practices for creating effective knowledge base content.

Writing Style​

Clarity and Conciseness​

  • Use simple, direct language
  • Avoid jargon unless necessary
  • Keep sentences and paragraphs short
  • Use active voice

Structure​

  • Start with the most important information
  • Use descriptive headings and subheadings
  • Include a summary at the beginning
  • End with next steps or related resources

Formatting Best Practices​

Text Formatting​

  • Use bold for emphasis
  • Use italics sparingly
  • Use heading levels appropriately (H1 for title, H2 for main sections, etc.)
  • Keep consistent formatting throughout

Lists and Tables​

  • Use bulleted lists for unordered items
  • Use numbered lists for sequential steps
  • Use tables to compare information
  • Keep tables simple and readable

Media Guidelines​

Images​

  • Use screenshots when helpful
  • Annotate screenshots to highlight important elements
  • Optimize images for web (compress when possible)
  • Include alt text for accessibility

Videos​

  • Keep videos short (2-5 minutes ideal)
  • Include captions
  • Provide a text summary
  • Host on a reliable platform

SEO Considerations​

  • Include relevant keywords naturally
  • Use descriptive titles
  • Create meaningful meta descriptions
  • Link to related content

Accessibility​

  • Use proper heading structure
  • Provide alt text for images
  • Ensure sufficient color contrast
  • Use descriptive link text