← All skills

documentation-guidelines

85 / 100 · Low risk

Fine to try.

By diegosouzapw/awesome-omni-skill (GitHub) · writing · 66 stars · scanned at commit a6b3c30

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.

Works with any agent that supports SKILL.md skills.

What this skill can do

Install

Paste this into your terminal. It downloads exactly the version we scanned, not whatever is newest.

if [ -e ~/.agents/skills/'documentation-guidelines' ] || [ -L ~/.agents/skills/'documentation-guidelines' ]; then echo 'A skill folder named documentation-guidelines already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/diegosouzapw/awesome-omni-skill' "$d" && git -C "$d" checkout --quiet 'a6b3c3005cedf056a48b084671c6282426d6e9fc' -- 'skills/documentation/documentation-guidelines' && mkdir -p ~/.agents/skills && cp -R "$d"/'skills/documentation/documentation-guidelines' ~/.agents/skills/'documentation-guidelines' && rm -rf "$d"; fi

Codex reads ~/.agents/skills directly. For Claude Code, Cursor, Copilot, Gemini CLI, Antigravity or OpenCode, also link it. For Claude Code: ln -s ~/.agents/skills/'documentation-guidelines' ~/.claude/skills/'documentation-guidelines' (other agents: ~/.cursor/skills, ~/.copilot/skills, ~/.gemini/skills, ~/.gemini/config/skills, ~/.config/opencode/skills). Or install through the finder skill, which does both.

Badge for your README

The badge for diegosouzapw/awesome-omni-skill shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/diegosouzapw/awesome-omni-skill.svg)](https://zalavijaysinh.github.io/skilltrust/repos/diegosouzapw/awesome-omni-skill/)

Score history