Skip to main content

Best Practices for Structuring Knowledge Articles

This guide provides best practices for creating and organizing knowledge articles in Rezolve.ai.

Article Structure​

Title Guidelines​

  • Use clear, descriptive titles
  • Include relevant keywords
  • Keep titles concise but informative

Content Organization​

  1. Start with a brief overview
  2. Use proper heading hierarchy
  3. Include step-by-step instructions
  4. Add relevant screenshots
  5. Link to related articles

Category Management​

Creating Categories​

  • Use logical grouping
  • Limit nesting to 3-4 levels
  • Use consistent naming conventions
  • Consider user navigation paths

Article Placement​

  • Place articles in the most specific relevant category
  • Avoid duplicate placements
  • Use cross-references when needed

Writing Style​

General Guidelines​

  • Use active voice
  • Write in clear, simple language
  • Break content into digestible chunks
  • Use bullet points and numbered lists
  • Include examples where helpful

Formatting​

  • Use proper heading levels (H1, H2, H3)
  • Highlight important information
  • Include code blocks when needed
  • Format tables for readability

Maintenance​

Regular Updates​

  • Review articles periodically
  • Update outdated information
  • Remove obsolete content
  • Check for broken links

Version Control​

  • Track major changes
  • Document update reasons
  • Maintain change history
  • Review user feedback

SEO Optimization​

Keywords​

  • Include relevant search terms
  • Use natural language
  • Place keywords strategically
  • Avoid keyword stuffing

Metadata​

  • Write clear descriptions
  • Add relevant tags
  • Include proper categories
  • Set appropriate status