Technical Documentation Writer
Writes clear, structured technical documentation for tools and libraries from the draft you provide: code reference, integration guide, runbook, an...
$5
Works with the AI tools you already use
Claude Code
Cursor
Codex CLI
GitHub Copilot
Gemini CLI+20 moreClaude CodeCursorCodex CLIGitHub CopilotGemini CLI
OpenClaw
Manus
Grok+17 agentsTechnical Documentation Writer
Example session with this skill installed
Write a code reference entry for this draft: function send_event(topic: str, payload: dict). It sends data to the bus. Returns a boolean. Fails with ConnectionError if the bus is down.
- Read your context and instructions
- Compiled the technical documentation writer
I have structured the documentation for the send_event function based on your draft notes.
Code Reference: Event Library
| Detail | Description |
|---|---|
| Name | send_event |
| Purpose | Dispatches a structured data payload to a specific message bus topic. |
| Parameters | topic (str): The destination channel name.<br>payload (dict): The data object to be transmitted. |
| Returns | bool: Returns True if the event was acknowledged by the bus, False otherwise. |
| Errors | ConnectionError: Raised when the message bus is unreachable or the network times out. |
Implementation Example
try:
success = send_event("user_signup", {"user_id": 123, "email": "test@example.com"})
if success:
print("Event delivered")
except ConnectionError as e:
print(f"Failed to connect to bus: {e}")
Next steps
- Verify the
ConnectionErrorimport path matches your project structure. - Add this entry to the
API_REFERENCE.mdfile under the "Core Functions" section. - Provide details for the
connect_busfunction to complete the integration guide.
Connects securely to your tools. The creator never sees your data.
What you get
About this skill
The problem
Writing documentation is a bottleneck that delays releases. Developers often leave libraries undocumented or produce fragmented notes that other engineers cannot follow without constant Slack interruptions.
What it does
- Generates comprehensive READMEs to orient first-time users and contributors.
- Builds structured code references for functions, classes, and public APIs.
- Drafts step-by-step integration guides for third-party consumers.
- Creates operational runbooks that map failure symptoms to specific fixes.
- Standardizes documentation structure across a codebase for better scan-ability.
Why this beats prompting it yourself
Generic LLM prompts often hallucinate features or produce flowery, imprecise prose. This skill enforces strict documentation archetypes, ensuring prerequisites are listed before steps and technical terms remain consistent across separate files without inventing non-existent parameters.
Use cases
- Preparing a library for internal handoff to another engineering team.
- Writing the initial documentation suite for a new open-source repository.
- Converting messy Slack notes and terminal logs into a production-ready runbook.
- Standardizing API references for a service after a major refactor.
Known limitations
Relies entirely on the provided draft or context. It will not scan external repositories or invent behavior not described in the input text.
How to install
Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.
- 1
Download the ZIP
Free skills download straight away. Paid skills unlock right after purchase.
- 2
Unzip into your skills folder
Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.
- 3
Ask your agent to use it
Restart the agent if it was already running. It picks the skill up automatically - no config needed.
Skills folder by agent
Click the path to copy it. Create the folder if it does not exist yet.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
Fresh listing
Recently published to Agensi
30-day refund
Not a fit? Get your money back
Trust & safety
Security scanned
Verified clean 16 days ago
- Passed all security checks, Safe to install