docs-worker

Generate README, AGENTS.md, CONTRIBUTING.md, and per-crate markdown from source inspection.

Updated Apr 8, 2026
One-click install
npx skills add https://github.com/LudwigAJ/swell --skill docs-worker-ludwigaj
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-worker
Source: https://github.com/LudwigAJ/swell/tree/main/.factory/skills/docs-worker
Command: npx skills add https://github.com/LudwigAJ/swell --skill docs-worker-ludwigaj

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the guesswork from writing and updating repository documentation by turning codebase inspection into accurate, consistent markdown for both humans and AI agents.

Core Features & Use Cases

  • README and onboarding docs: Create or refresh repository-level documentation that explains installation, usage, and workflows.
  • AGENTS.md and per-crate docs: Produce module- or crate-specific guidance covering responsibility, public APIs, testing patterns, and integration points.
  • Verification-first writing: Cross-check file paths, type names, and commands against the codebase so the resulting documentation stays grounded in reality.

Quick Start

Ask the docs-worker skill to inspect the repository and draft the required markdown documentation with verified commands, paths, and code references.

Frequently Asked Questions about docs-worker

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

FAQPage Schema
How do I generate accurate repository documentation from my codebase?

Generate accurate repository documentation by inspecting source code to draft markdown files with verified commands, paths, and code references. This process cross-checks file paths and type names against the codebase to keep README and onboarding docs grounded in reality.

What is AGENTS.md and how do I create it for my repository?

AGENTS.md is module- or crate-specific guidance for AI agents covering responsibilities, public APIs, testing patterns, and integration points. Create it by inspecting the codebase to produce accurate markdown documentation that defines agent-facing workflows and integration points.

How do I write per-crate documentation with verified build instructions?

Write per-crate documentation by inspecting source code and validating build commands before drafting markdown. This verification-first writing cross-checks file paths, type names, and build instructions against the actual codebase to ensure crate-level responsibility docs remain accurate.

Can I use this to update existing README and CONTRIBUTING files?

Yes, you can refresh existing README and CONTRIBUTING files by inspecting the current codebase state and regenerating markdown. The documentation process applies consistency checks across links, type names, and commands to update onboarding guides and usage references accurately.

What's the best way to keep technical documentation consistent with source code?

Keep technical documentation consistent with source code by cross-checking file paths, type names, and commands against the codebase during generation. This verification-first approach ensures markdown documentation for humans and AI agents stays grounded in reality.

Does automated documentation generation work for onboarding guides and usage references?

Automated documentation generation works for onboarding guides and usage references by inspecting the repository to draft required markdown. It validates commands and code references, ensuring both human- and agent-facing documentation accurately reflects installation workflows and integration points.