docs-createlisted

This skill should be used when creating new documentation files or updating existing ones, especially when documenting system architecture, features, integrations, workflows, or technical decisions. Also use when asked to "document", "write docs for", or "create a doc about" any system component. Trigger this skill whenever the user wants to capture knowledge about how something works, even if they don't explicitly say "documentation" — phrases like "explain how X works and save it", "write up the auth flow", or "I need a reference for the API" all qualify.
devgirishattri/agent-plugins · ★ 0 · Data & Documents · score 72

Install: claude install-skill devgirishattri/agent-plugins

# Creating Documentation A structured process for creating and updating project documentation. Documents use **reference-based notation** (function names, table names, file paths) for describing what exists, because references stay accurate as code evolves while line numbers and copied code rot immediately. Use **focused code examples** for showing how to do things — recurring patterns, conventions, and interfaces that developers need to copy and adapt. ## Process 0. **Reviewer-role preflight — MANDATORY, run FIRST, before any other step.** Resolve `PLUGIN_ROOT` from the absolute source path Codex supplied for this selected `SKILL.md` (go up two directories from `<plugin-root>/skills/docs-create/SKILL.md`). In a separate read-only step, resolve the repository root with `git rev-parse --show-toplevel`; if this is not a Git repository, resolve the current working directory instead. Substitute both absolute paths literally below. Invoke the preflight as one literal Bash segment (no `export`/`env`/assignment prefix, command substitution, chaining, piping, or redirection): ```bash bash "<PLUGIN_ROOT>/scripts/docs-write.sh" --repo "<REPO_ROOT>" ``` Exit `0` means proceed. Any non-zero exit — including `6` with stderr `reviewer role: docs writes refused`, or an unresolved fleet identity asking to set `KNOWLEDGE_PANE_NAME` — means **stop immediately**: do not create/edit/delete any file (including `TODO.md`/`ISSUES.md`), and relay the script's stderr line as the reason