Documentation Guidelines

Overview

Workflow

1. Locate the repo's documentation rules (prefer

   docs/memories/DOCUMENTATION_GUIDELINES.md

   ). If missing, load

   references/documentation-guidelines.md

   .
2. Determine the correct documentation path for the current project. Use the repo's conventions; if no zones exist, default to

   docs/features/<module>.md

   (or the project's documented location).
3. Create or update the module doc before changing logic. Remove outdated content instead of appending.
4. Follow the required section order from the guidelines and keep the doc in English.

Required Content Checklist

• Start every doc with YAML frontmatter metadata (

  name

  ,

  description

  ,

  version

  ,

  last_updated

  ,

  maintained_by

  ), then write the rest as standard Markdown sections.
• Include Mermaid ERD and Mermaid flowchart.
• Document controllers/routes, requests, resources, models, services, jobs, and providers.
• Provide endpoint table, headers, payloads, response examples, and error dictionary.
• State permissions, feature flags, and client consumption rules.
• Add local development + seeding commands and troubleshooting/log hints.

Style Rules

• Use frontmatter + Markdown consistently (no plain-text-only docs).
• Describe contracts and behavior, not UI.
• Use tables for endpoints and business rules.
• Keep Mermaid labels short and safe; wrap special characters in quotes if needed.
• Delete obsolete text to keep the doc clean and non-duplicative.

Frontend API Documentation

docs/memories/FRONTEND_API_DOCUMENTATION_GUIDELINES.md

Resources

• references/documentation-guidelines.md

  : Canonical structure and ordering for backend feature documentation.