documentation-guidelines

SKILL.md

Overview Produce a single, canonical module doc that matches the repository's documentation rules and keeps backend/API contracts consistent and skimmable.

Frontend API Documentation If the user explicitly asks for frontend-facing API docs, load the repo's frontend guideline file (typically docs/memories/FRONTENDAPIDOCUMENTATIONGUIDELINES.md) and follow it.

Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding instructions. Source: thienanblog/awesome-ai-agent-skills.

Open your terminal or command line tool (Terminal, iTerm, Windows Terminal, etc.) Copy and run this command: npx skills add https://github.com/thienanblog/awesome-ai-agent-skills --skill documentation-guidelines Once installed, the skill will be automatically configured in your AI coding environment and ready to use in Claude Code or Cursor

View raw