← All skills

write-docs

100 / 100 · Low risk

Fine to try.

By dzhng/skills (GitHub) · coding · 1,470 stars · scanned at commit 828e386

Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.

Works with any agent that supports SKILL.md skills.

What this skill can do

We found nothing in the files we read that matches our rules. That does not prove the skill is safe: see the limits of static scanning.

Install

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

if [ -e ~/.agents/skills/'write-docs' ] || [ -L ~/.agents/skills/'write-docs' ]; then echo 'A skill folder named write-docs already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/dzhng/skills' "$d" && git -C "$d" checkout --quiet '828e386301530b406b2fbd6d48136eae75720262' -- 'skills/engineering/write-docs' && mkdir -p ~/.agents/skills && cp -R "$d"/'skills/engineering/write-docs' ~/.agents/skills/'write-docs' && 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/'write-docs' ~/.claude/skills/'write-docs' (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 dzhng/skills shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/dzhng/skills.svg)](https://zalavijaysinh.github.io/skilltrust/repos/dzhng/skills/)

Score history