docs-worker

Generate and update package documentation from source code analysis.

6|1|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/outfitter-dev/outfitter --skill docs-worker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-worker
Source: https://github.com/outfitter-dev/outfitter/tree/main/.factory/skills/docs-worker
Command: npx skills add https://github.com/outfitter-dev/outfitter --skill docs-worker

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of package documentation, ensuring that documentation accurately reflects the codebase and follows established patterns.

Core Features & Use Cases

  • Code Analysis: Reads source code to understand APIs, types, and usage patterns.
  • Documentation Writing: Generates READMEs, pattern guides, and API documentation.
  • Verification: Ensures documentation matches actual code and passes linting/type checks.
  • Use Case: When a new feature is added to a package, this Skill can automatically generate or update the relevant documentation in the docs/ directory and the package's README.

Quick Start

Use the docs-worker skill to write documentation for the new feature described in the Linear issue.

Frequently Asked Questions about docs-worker

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate package documentation from source code automatically?

To generate package documentation from source code, this Skill analyzes your codebase to understand APIs, types, and usage patterns, then automatically writes the corresponding READMEs and API docs to match your established patterns.

What is the best way to update READMEs and API docs after adding a new feature?

The best way to update READMEs and API docs after adding a new feature is using automated code analysis, which reads your source changes and updates the relevant documentation in the docs directory to accurately reflect the new functionality.

Can I verify that my technical documentation matches the actual codebase?

You can verify your technical documentation matches the codebase through built-in verification checks, ensuring that generated READMEs and pattern guides pass linting and type checks against the actual source code.

Do I need to manually write pattern guides if I use code analysis for documentation?

You do not need to manually write pattern guides if you use code analysis for documentation, because the process automatically reads your established codebase patterns and generates matching technical guides for your package.

What types of documentation can be generated by analyzing source code?

By analyzing source code, you can generate package READMEs, API documentation, and pattern guides, ensuring all technical writing accurately reflects your current APIs and usage patterns.