shipflow-docs

Generate and update project documentation for README, APIs, and UI components.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/dianedef/ShipFlow --skill shipflow-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shipflow-docs
Source: https://github.com/dianedef/ShipFlow/tree/main/.claude/skills/shipflow-docs
Command: npx skills add https://github.com/dianedef/ShipFlow --skill shipflow-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation and updating of project documentation, ensuring that your code, APIs, and components are well-described and discoverable.

Core Features & Use Cases

  • File Documentation: Generates inline documentation for specific code files.
  • README Generation/Update: Creates or updates the project's main README file.
  • API Documentation: Documents all API routes and endpoints.
  • Component Documentation: Documents UI components and their props.
  • Gap Detection: Identifies and suggests areas needing documentation.
  • Use Case: After adding new API endpoints to your project, run this Skill with the 'api' argument to automatically generate documentation for them in docs/API.md.

Quick Start

Use the shipflow-docs skill to generate documentation for the README file.

Frequently Asked Questions about shipflow-docs

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

FAQPage Schema
How do I automatically generate README and API documentation for my codebase?

You can automatically generate README and API documentation by analyzing your code structure, package.json, and CLAUDE.md files to identify documentation needs and create relevant content across various formats.

Can I document UI components and their props in Astro, Vue, or Next.js projects?

Yes, you can document UI components and their props in Astro, Vue, and Next.js projects. The system identifies component structures and generates corresponding documentation automatically.

How does code structure analysis identify gaps in existing project documentation?

Code structure analysis identifies documentation gaps by examining your files, package.json, and CLAUDE.md to detect undocumented APIs, components, and README sections, then suggesting areas needing content.

What is the best way to update API endpoint documentation after adding new routes?

The best way to update API endpoint documentation is to run the documentation generation process with the 'api' argument, which automatically documents all newly added API routes in a dedicated docs/API.md file.

Does this documentation generation tool support Python and TypeScript projects?

Yes, this documentation generation tool supports Python and TypeScript projects, alongside JavaScript, Astro, Vue, and Next.js environments, ensuring broad language coverage for your codebase.

How do I generate inline documentation for specific code files?

You can generate inline documentation for specific code files by running the file documentation feature, which analyzes individual file structures and automatically inserts relevant descriptive content directly into the code.