Documentation
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
$ npx promptcreek add documentationAuto-detects your installed agents and installs the skill to each one.
What This Skill Does
This skill assists in writing clear and maintainable technical documentation for various audiences and purposes. It provides guidance on different document types, including READMEs, API documentation, runbooks, architecture docs, and onboarding guides. It's designed to help developers create effective and useful documentation.
When to Use
- Create a README for a new project.
- Document an API endpoint with examples.
- Write a runbook for incident response.
- Describe the architecture of a system.
- Develop an onboarding guide for new team members.
- Improve existing documentation for clarity.
Key Features
Installation
$ npx promptcreek add documentationAuto-detects your installed agents (Claude Code, Cursor, Codex, etc.) and installs the skill to each one.
View Full Skill Content
Technical Documentation
Write clear, maintainable technical documentation for different audiences and purposes.
Document Types
README
- What this is and why it exists
- Quick start (< 5 minutes to first success)
- Configuration and usage
- Contributing guide
API Documentation
- Endpoint reference with request/response examples
- Authentication and error codes
- Rate limits and pagination
- SDK examples
Runbook
- When to use this runbook
- Prerequisites and access needed
- Step-by-step procedure
- Rollback steps
- Escalation path
Architecture Doc
- Context and goals
- High-level design with diagrams
- Key decisions and trade-offs
- Data flow and integration points
Onboarding Guide
- Environment setup
- Key systems and how they connect
- Common tasks with walkthroughs
- Who to ask for what
Principles
- Write for the reader — Who is reading this and what do they need?
- Start with the most useful information — Don't bury the lede
- Show, don't tell — Code examples, commands, screenshots
- Keep it current — Outdated docs are worse than no docs
- Link, don't duplicate — Reference other docs instead of copying
Supported Agents
Attribution
Details
- License
- MIT
- Source
- admin
- Published
- 3/18/2026
Tags
Related Skills
Agent Protocol
Inter-agent communication protocol for C-suite agent teams. Defines invocation syntax, loop prevention, isolation rules, and response formats. Use when C-suite agents need to query each other, coordinate cross-functional analysis, or run board meetings with multiple agent roles.
CTO Advisor
Technical leadership guidance for engineering teams, architecture decisions, and technology strategy. Use when assessing technical debt, scaling engineering teams, evaluating technologies, making architecture decisions, establishing engineering metrics, or when user mentions CTO, tech debt, technical debt, team scaling, architecture decisions, technology evaluation, engineering metrics, DORA metrics, or technology strategy.
Agent Workflow Designer
Agent Workflow Designer