write-docs

Name: write-docs
Availability: InStock
Author: Helio

Create and maintain structured repository documentation with frontmatter and index regeneration.

88|6|Updated Mar 25, 2026

Search Tags:#documentation #knowledge base #docs #frontmatter #repository standards #index regeneration

Ready to run

npx skills add https://github.com/heliohq/ship --skill write-docs-heliohq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/heliohq/ship/tree/main/skills/write-docs
Command: npx skills add https://github.com/heliohq/ship --skill write-docs-heliohq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns ad hoc documentation updates into a consistent, governed process for creating and maintaining structured docs under docs/ with clear ownership, lifecycle status, and discoverability.

Core Features & Use Cases

Structured document creation: Create new guides, references, troubleshooting notes, and design docs with required frontmatter and naming conventions.
Safe documentation updates: Revise existing docs without erasing history, while preserving status, cross-references, and last-modified tracking.
Index and governance support: Regenerate the docs index after changes and apply category rules such as numbering, related links, and status lifecycle checks.

Quick Start

Ask the AI to create or update a docs/ file that follows the frontmatter, numbering, status, and index regeneration rules in this Skill.

Frequently Asked Questions about write-docs

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

FAQPage Schema

How do I maintain structured repository documentation with frontmatter and lifecycle status?▼

Maintain structured repository documentation by applying required frontmatter, numbering, lifecycle status, and cross-reference conventions to guides and references. This ensures docs remain current and governed through index regeneration and status validation.

What is the best way to regenerate a docs index after updating repository guides?▼

The best way to regenerate a docs index is to apply category rules such as numbering, related links, and status lifecycle checks after revising existing documentation. This preserves cross-references and ensures accurate content discoverability.

How do I create new troubleshooting notes and design docs in a docs directory?▼

Create new troubleshooting notes and design docs by following structured naming conventions and adding required frontmatter. This governs the documentation process by establishing clear ownership and lifecycle status from the start.

Can I update existing docs without erasing history or breaking cross-references?▼

You can update existing docs safely by preserving status, cross-references, and last-modified tracking. Revising documentation this way prevents history loss while maintaining structural integrity across the knowledge base.

Why does documentation require code-verified claims before marking content as current?▼

Documentation requires code-verified claims before marking content as current to ensure accuracy and prevent outdated information. Status validation enforces this lifecycle check, guaranteeing that current docs reflect verified repository behavior.

When do I need structured documentation governance for a knowledge base?▼

You need structured documentation governance when ad hoc updates cause inconsistent ownership, unclear lifecycle status, and poor discoverability. Applying frontmatter standards and index regeneration turns fragmented docs into a searchable knowledge base.