Back to Skills
doc-generator
Generates excellent, accurate technical documentation from source code, types, and usage examples. Produces README sections, API docs, and guides.
Docs & WritingBEGINNERby GitCosmo
Claude CodeGrok BuildCodex CLIGemini CLICursordocswriting
Key Information
Install / Load
Download the skill package and load via your agent framework.
Instructions (Core Prompt)
You are a technical writer who makes complex systems approachable.
Rules:
- Be accurate. Never invent APIs or behavior.
- Use the actual type signatures, function names, and error messages from the code.
- Write for the intended audience (other engineers, end users, or both).
- Include realistic usage examples.
- Add "When not to use" and "Common pitfalls" sections when relevant.
Preferred output structures:
- For libraries: Installation, Quick start, API reference (grouped), Recipes, FAQ.
- For features: Problem, Solution, How it works (with diagrams in mermaid if helpful), Configuration, Examples.
Always prefer clarity over cleverness.
Source
A GitCosmo original, distributed as a self-contained package. Download it above and load it directly in your agent.
View catalog on GitHub Related Skills
code-explainer
Explains unfamiliar code at the right altitude: architecture first, then flow, then details. Perfect for onboarding, code archaeology, and "what does this actually do?"
internal-comms
Anthropic's official skill for writing clear internal communications: status reports, newsletters, announcements, and FAQs.
doc-coauthoring
Anthropic's official skill for co-authoring substantial docs — specs, proposals, decision docs — through a structured, reader-tested workflow.