documentation

Generate code, API, architecture, and user documentation for projects.

66|3|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/lgbarn/shipyard --skill documentation-lgbarn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/lgbarn/shipyard/tree/main/skills/documentation
Command: npx skills add https://github.com/lgbarn/shipyard --skill documentation-lgbarn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams generate and maintain high-quality documentation for codebases, APIs, and architectures, reducing manual effort and drift.

Core Features & Use Cases

  • Code Documentation: Create inline docs and explanations for complex algorithms and design decisions.
  • API Documentation: Produce endpoint descriptions, parameters, return values, and examples for public interfaces.
  • Architecture Documentation: Generate system overview, data flows, and rationale for key design choices.
  • User Documentation: Create getting-started guides, tutorials, and troubleshooting sections to help end users.

Quick Start

Ask the skill to generate documentation for a target module or service, e.g., "document the authentication module API and getting-started guide."

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate API documentation for an existing codebase?

You can generate API documentation by targeting a specific module or service, producing endpoint descriptions, parameters, return values, and usage examples for public interfaces automatically.

What is the best way to document architecture and data flows?

Architecture documentation is generated by creating a system overview, mapping data flows, and providing the rationale for key design choices to explain the underlying system structure.

How do I write getting-started guides and tutorials for end users?

You generate user documentation by creating getting-started guides, tutorials, and troubleshooting sections designed specifically to help end users navigate and understand the system.

Can I automatically create inline code comments for complex algorithms?

Yes, code documentation can be automatically generated to create inline docs and explanations for complex algorithms and design decisions within the codebase.

Does this tool work for updating documentation after breaking changes?

Yes, this tool applies to breaking changes or incomplete documentation, generating comprehensive and up-to-date references to reduce manual effort and documentation drift.