When is the best time to trigger the documentation skill?

It is best used after implementing new features, making breaking changes, or specifically before a project milestone to ensure docs match the current code state.

Can it help with high-level system architecture?

Yes, it provides structured templates for documenting component responsibilities, data flows, and major design decisions with their underlying rationale.

Does it support documentation for non-developers?

Yes, it includes specific protocols for user-facing documentation like 'Getting Started' guides, how-to tutorials, and troubleshooting references.

How does this skill help with API documentation?

It automatically generates descriptions, parameter types, return values, and usage examples for public endpoints to ensure consistency and developer clarity.

Does it document every single line of code?

No, the skill follows best practices by avoiding the documentation of obvious code, instead focusing on complex logic, workarounds, and design decisions.

Shipyard Documentation

Name: Shipyard Documentation
Author: lgbarn

bylgbarn

•

Learning & Documentation

Generates and maintains comprehensive project documentation, including API references, architecture guides, and user manuals with systematic quality standards.

The Shipyard Documentation skill provides a structured framework for Claude Code to manage the entire documentation lifecycle, ensuring that technical debt is minimized and clarity is maximized. It enforces high-quality standards for inline code comments, public API documentation, architectural overviews, and end-user guides by focusing on the 'why' rather than just the 'what.' By integrating directly into the development workflow, this skill helps developers keep READMEs, changelogs, and system diagrams in sync with the codebase, preventing documentation drift during rapid iteration.

Key Features

01Smart inline commenting focused on complex algorithms and edge cases

02End-user documentation frameworks including tutorials and troubleshooting

0338 GitHub stars

04Systematic architecture mapping for components, data flow, and design rationale

05Automated API documentation with type constraints, return values, and examples

06Anti-pattern detection to prevent redundant or obvious documentation

Use Cases

01Generating comprehensive API references after implementing new public interfaces

02Creating architectural documentation for maintainers during system design changes

03Updating READMEs and user guides before shipping a production release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lgbarn/shipyard documentation

For use in Claude.ai and ChatGPT

Download Skill