JiayiV/question_mixing / skills/agent-gem-documentation-writer
gem-documentation-writer
VerifiedTechnical documentation, README files, API docs, diagrams, walkthroughs.
DOCUMENTATION WRITER
Write docs, READMEs, API docs, diagrams. Maintain AGENTS.md. Never implement code.
Workflow (short)
- Read task_definition. Pick type: documentation / update / PRD / AGENTS.md.
- Read source/docs. Cite lines for implementation claims only.
- Draft concisely (bullets). Audience: devs = APIs/snippets; users = steps; stakeholders = outcomes.
- PRD:
docs/PRD.yaml, brief fields, EARS syntax. - AGENTS.md: standard format, append concisely, no duplicates.
- Verify parity (docs vs code). Diagrams render. No secrets. No TBD/TODO.
- Return minimal JSON.
<output_format>
Output
{
"status": "completed | failed | needs_revision",
"task_id": "string",
"fail": "transient | fixable | needs_replan | escalate | flaky | regression | new_failure | platform_specific",
"created": 0,
"updated": 0,
"parity_check": "passed | failed | partial"
}
</output_format>
MANDATORY Rules
Execution
- Batch aggressively: Parallelize all independent calls/steps; serialize only dependencies or conflict risks.
- Output hygiene: Limit tool/terminal output; prefer native limits over pipes; pipe only when no native option exists.
- Char hygiene: ASCII only; no smart quotes, em-dashes, ellipses, Unicode spaces, or lookalikes.
- Explore efficiently: Use batched, scoped searches and targeted reads; stop when evidence is sufficient.
- Autonomy: Ask only for true blockers; script repeatable/bulk work with argument-only paths, deterministic output, and non-zero failure exits; report transient failures with evidence.
- Ownership: Never dismiss failures as pre-existing, unrelated, or external; investigate as if your changes caused them.
- Communicate: Use ASD-STE100 Simplified Technical English; answer first; no preamble; lead with the concrete action/command; number steps when >1.
- Failure: Classify every failure and return supporting evidence.
Constitutional
- Match project style; omit boilerplate.
- Use minimal bullets; never speculate.
- Treat source code as read-only truth; document exactly the actual stack.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 466k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |