ship-docs

Generate architecture docs, how-to guides, and API references for features.

2|Updated Jun 18, 2026
One-click install
npx skills add https://github.com/bllshttng/footnote --skill ship-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ship-docs
Source: https://github.com/bllshttng/footnote/tree/main/skills/ship-docs
Command: npx skills add https://github.com/bllshttng/footnote --skill ship-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the creation of technical and end-user documentation for features, reducing manual effort and ensuring up-to-date documentation.

Core Features & Use Cases

  • Documentation Generation: Automates the generation of architecture docs, how-to guides, and API references.
  • Feature-specific Documentation: Generates specific types of documentation depending on the feature and its scope.
  • Integration with Target: Seamlessly integrates with the Target workflow for end-to-end feature delivery.

Quick Start

Run the 'ship-docs' skill with the target 'add OAuth login'.

Frequently Asked Questions about ship-docs

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

FAQPage Schema
How do I automate documentation generation for new project features?

Automated documentation generation creates architecture documents, how-to guides, and API references by applying specified templates and reference materials to your feature delivery workflow. This reduces manual effort and ensures documentation remains up-to-date.

What types of technical documentation can be generated automatically?

Technical documentation generation can automatically produce architecture documents, how-to guides, and API references. The specific type generated depends on the feature and its scope, ensuring the output matches the documentation needs of the project.

How does automated documentation integrate with feature delivery workflows?

Automated documentation integrates with the feature delivery workflow by generating end-user and technical docs alongside the feature itself. This integration ensures documentation is created as part of the end-to-end feature delivery process.

Do I need to provide templates and reference materials for project documentation generation?

Project documentation generation requires specified templates and reference materials to function correctly. These inputs guide the creation of architecture docs, how-to guides, and API references, ensuring the generated documentation matches your project standards.

Can I generate end-user documentation and API references at the same time?

Yes, you can generate end-user documentation and API references simultaneously. The documentation process handles both technical and end-user materials, creating specific types of documentation depending on the feature and its scope.

What is the best way to keep architecture documents up-to-date with new features?

The best way to keep architecture documents up-to-date is to automate the documentation process within the feature delivery workflow. By generating docs automatically when a feature is shipped, you ensure documentation is always current and reflects the latest changes.