Skip to main content

Article Templates

Standardize your knowledge base content using predefined templates.

Available Templates

  1. How-to Guide

    # How to [Task Name]

    ## Overview
    Brief description of the task

    ## Prerequisites
    - Required items
    - Required permissions

    ## Steps
    1. First step
    2. Second step
    3. Final step

    ## Troubleshooting
    Common issues and solutions
  2. Problem-Solution

    # [Problem Title]

    ## Problem Description
    Detailed description

    ## Solution
    Step-by-step solution

    ## Prevention
    How to prevent this issue
  3. Feature Documentation

    # [Feature Name]

    ## Description
    Feature overview

    ## Configuration
    Setup instructions

    ## Usage
    How to use the feature

    ## Examples
    Practical examples

Using Templates

  1. Select appropriate template
  2. Fill in required sections
  3. Add custom content as needed
  4. Review and format
  5. Submit for review

Best Practices

  • Keep consistent formatting
  • Include all required sections
  • Add relevant metadata
  • Link to related articles
  • Use proper versioning