Skip to main content

How to Use Templates

This section contains templates to facilitate the creation and updating of backend development documentation.

Available Templates​

1. New Guide Template (new-guideline-template.md)​

Use this template when you need to create a new development guide.

Steps to use:

  1. Copy the new-guideline-template.md file
  2. Rename with a descriptive name (e.g., api-design-guidelines.md)
  3. Replace all [PLACEHOLDER] placeholders with real content
  4. Update the sidebar_position as appropriate
  5. Follow the standard review process

2. Update Checklist (update-checklist-template.md)​

Use this checklist when updating existing documentation.

Steps to use:

  1. Copy the template content
  2. Complete the general information
  3. Use the checklist during the update process
  4. Include in the PR as evidence that the process was followed

Naming Conventions​

  • Use kebab-case for file names
  • Include descriptive keywords
  • Avoid unclear abbreviations

Examples:

  • ✅ api-design-guidelines.md
  • ✅ database-migration-process.md
  • ❌ guide1.md
  • ❌ db_mig.md

To maintain logical order in navigation:

  • 1-2: Introductory documents
  • 3-5: Fundamental guides (commit, workflow, coding standards)
  • 6-8: Specific guides and best practices
  • 9: Maintenance
  • 10+: Templates and additional resources