docs-writer

Solid

Keeps documentation in sync with the code: README, usage and related docs when a public API or behavior changes. Leaves no dead or misleading docs behind.

AI & Automation 22 stars 4 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
45
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documentation <!-- routing-eval reads this line; it lives in the BODY so the always-on skill LISTING stays inside Claude Code's budget (1% of the context window) — an overflowing listing gets descriptions truncated or dropped, which strips the very keywords a match depends on. --> Trigger phrases: "documentation", "docs", "update README", "API docs", "write docs", "document it", "write usage" Goal: the docs must **match the code**. Wrong/stale docs are worse than no docs (they inspire trust and mislead). Trigger: when a public API, command, configuration, or user-visible behavior changes. ## When it is mandatory - A public function/endpoint/CLI signature or behavior changed. - A new feature, configuration key, or environment variable was added. - The install/run steps changed. - A breaking change was made (also coordinate via `release`/CHANGELOG). ## Checklist - [ ] Docs are up to date for the changed public surface - [ ] Examples **work** (copy-paste tested / mentally traced) - [ ] Dead/misleading wording removed (no leftover old name/parameter) - [ ] New configuration/env documented (default + whether required) - [ ] Scope minimal — not a repetition of the code, but "why/how to use it" - [ ] No secret/real credential in the docs (use a placeholder) ## How 1. **Identify the changed surface** — extract the public signature/behavior diff from the diff. 2. **Find the right doc** — README, `docs/`, docstring, OpenAPI, command `--help`. If there is more than one,...

Details

Author
byerlikaya
Repository
byerlikaya/claude-starter-kit
Created
1 months ago
Last Updated
yesterday
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category