documentation-engineer

Included with Lifetime

$97 forever

Use this skill after design decisions or major code changes to update documentation. Creates per-directory CLAUDE.md files and maintains top-level CLAUDE.md and ARCHITECTURE.md. Trigger after completing features, refactoring, or architectural changes.

Design

What this skill does


# Documentation Engineer Protocol

Write docs that help Claude and humans understand code fast. Be brief. Use examples. Skip the fluff.

## Core Principles

- **Concise over complete** - One clear sentence beats three vague ones
- **Examples over explanations** - Show, don't tell
- **Simple words** - "use" not "utilize", "get" not "retrieve"
- **No decoration** - No ASCII art, no fancy formatting, no emoji
- **Update, don't append** - Keep docs current, remove outdated info

## File Structure

```
project/
├── CLAUDE.md           # Project overview, key patterns, gotchas
├── ARCHITECTURE.md     # System design, data flow, major components
├── src/
│   ├── CLAUDE.md       # This directory's purpose and patterns
│   ├── auth/
│   │   └── CLAUDE.md   # Auth-specific context
│   └── api/
│       └── CLAUDE.md   # API-specific context
```

## Top-Level CLAUDE.md

What to include:
- Project purpose (1-2 sentences)
- How to run/build/test (commands only)
- Key patterns used throughout
- Common gotchas
- Important conventions

Example:
```markdown
# Project

Order management API for retail clients.

## Commands

npm install
npm run dev      # localhost:3000
npm test         # run all tests

## Patterns

- All handlers in src/handlers/, one file per endpoint
- Validation via zod schemas in src/schemas/
- Errors thrown as HttpError(code, message)

## Gotchas

- Tests require local postgres running
- Auth tokens expire after 1 hour in dev
```

## Top-Level ARCHITECTURE.md

What to include:
- High-level system diagram (text, not ASCII art)
- Major components and their responsibilities
- Data flow for key operations
- External dependencies

Example:
```markdown
# Architecture

## Components

**API Server** (src/api/)
Handles HTTP requests. Validates input, calls services, returns responses.

**Services** (src/services/)
Business logic. No HTTP awareness. Returns plain objects or throws errors.

**Database** (src/db/)
Postgres via pg-promise. All queries in repository files.

**Queue** (src/queue/)
Redis-backed job queue for async tasks. Workers in src/workers/.

## Data Flow: Create Order

1. POST /orders hits OrderHandler
2. Handler validates via OrderSchema
3. Handler calls OrderService.create()
4. Service checks inventory, calculates totals
5. Service calls OrderRepository.insert()
6. Service queues confirmation email
7. Handler returns 201 with order ID
```

## Per-Directory CLAUDE.md

Keep it short. Cover:
- What this directory contains
- Key files and their purposes
- Patterns specific to this directory
- Example usage if not obvious

Example:
```markdown
# src/auth/

Handles authentication and authorization.

## Files

- middleware.ts - Express middleware, attaches user to req
- tokens.ts - JWT creation and verification
- permissions.ts - Role-based access checks

## Usage

// In a route
app.get('/admin', authMiddleware, requireRole('admin'), handler)

// Check permission manually
if (canAccess(user, 'orders:write')) { ... }
```

## Writing Style

**Do:**
```markdown
Returns user object or null if not found.
```

**Don't:**
```markdown
This function is responsible for retrieving the user object from the
database. In cases where the user cannot be found, it will return a
null value to indicate the absence of the requested user.
```

**Do:**
```markdown
## Usage

const user = await getUser(id)
if (!user) return notFound()
```

**Don't:**
```markdown
## Usage Instructions

In order to properly utilize this function, you will need to first
ensure that you have a valid user ID. Then, you can call the function
as demonstrated in the following comprehensive example...
```

## When to Update

Update docs after:
- Adding new directories
- Changing key patterns
- Adding/removing major components
- Changing build/run commands
- Discovering gotchas worth noting

Remove from docs when:
- Feature/pattern no longer exists
- Command changed
- File was deleted/renamed

## Checklist

Before finishing:
- [ ] Is every sentence necessary?
- [ ] Could this be shorter?
- [ ] Is there an example for anything non-obvious?
- [ ] Did I remove outdated info?
- [ ] Would a new dev understand this in 30 seconds?

## Calibration

**Stay in your lane.** Don't cover:
- Code implementation or review (brevity-engineer)
- Linting/type checking (linting-engineer)
- What features to build (product-manager)

Files: 1

Size: 4.6 KB

Complexity: 9/100

Category: Design

Source: https://github.com/oxhagolli/clawdskillz/tree/main/skills/documentation-engineer

Related in Design

contribute

Included

Local-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".

Designscripts

architectural-analysis

Included

User-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).

Designscripts

mcp

Included

Model Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.

Designscripts

react-native-skia

Included

Design, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.

Designscripts

plaid

Included

Product Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".

Designscripts

nextjs-framer-motion-animations

Included

Adds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.

Designscripts