Skip to main content

Content Guidelines

Best practices and guidelines for creating effective knowledge base content.

Writing Style

  • Use clear, concise language
  • Write in active voice
  • Keep sentences short and direct
  • Use consistent terminology

Article Structure

  1. Title

    • Clear and descriptive
    • Include relevant keywords
    • Follow naming conventions
  2. Introduction

    • Brief overview
    • Purpose of the article
    • Target audience
  3. Main Content

    • Step-by-step instructions
    • Screenshots or visuals
    • Examples where applicable
    • Code snippets (if technical)
  4. Conclusion

    • Summary
    • Next steps
    • Related articles

Formatting Guidelines

  • Use proper heading hierarchy
  • Include bullet points for lists
  • Add numbered steps for procedures
  • Format code blocks properly
  • Include alt text for images

SEO Best Practices

  • Use relevant keywords naturally
  • Write descriptive meta descriptions
  • Include proper tags
  • Link to related content
  • Update content regularly

Quality Checklist

  • Content is accurate and up-to-date
  • Grammar and spelling are correct
  • Links are working
  • Images are optimized
  • Formatting is consistent