docs-worker

name	docs-worker
description	Writes package documentation from code analysis — READMEs, pattern guides, API docs.

Docs Worker

NOTE: Startup and cleanup are handled by worker-base. This skill defines the WORK PROCEDURE.

When to Use This Skill

Use for features that involve writing or updating documentation:

• Package-level docs in packages/<pkg>/docs/
• README updates for packages
• Migration guides
• Pattern documentation (error handling, CLI patterns, etc.)

Work Procedure

1. Understand the Feature

• Read the feature description — it references a Linear issue specifying what to document.
• Read AGENTS.md for mission boundaries, key source files, and conventions.
• Read .factory/library/architecture.md for cross-package patterns.

2. Analyze the Source Code

This is the most critical step. Documentation MUST match actual code, not assumptions.

• Read ALL source files relevant to the APIs being documented.
• Read existing tests to understand intended behavior and edge cases.
• Read existing README for the package to understand current doc style and structure.
• Grep for actual function signatures, exported types, and real usage patterns.
• Check package.json exports field to understand available subpath imports.

Anti-pattern: Do NOT document APIs that don't exist (phantom APIs). Verify every function name, every parameter, every type before writing about it. Use grep to confirm:

rg "export.*functionName" packages/<pkg>/src/

3. Write Documentation