Skills
.Work. You
Rest

documentation-guidelines

Community

Create consistent, up-to-date backend docs.

Software Engineering#architecture#documentation#mermaid#backend#endpoints#seeding#api-contracts
Authorthienanblog
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Documentation for backend modules is often inconsistent, scattered across projects, and hard for developers and AI agents to trust. This guide provides a single canonical set of rules and templates to ensure backend docs stay aligned with repository guidelines, including architecture diagrams, API contracts, and seeding instructions.

Core Features & Use Cases

  • Generates or updates module docs to match the repository's DOCUMENTATION_GUIDELINES.md.
  • Ensures inclusion of architecture diagrams (Mermaid ERD/flowcharts), endpoints, payloads, data models, services, and provider details.
  • Enables consistent documentation across projects for backend developers, frontend teams, and AI agents.

Quick Start

Create or update the module documentation for the target repository following its DOCUMENTATION_GUIDELINES.md.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-guidelines
Download link: https://github.com/thienanblog/awesome-ai-agent-skills/archive/main.zip#documentation-guidelines

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.