documentation

Write README, API, Runbook, Architecture, and Onboarding documentation.

1|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/kiryteo/opencode-setup --skill documentation-kiryteo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/kiryteo/opencode-setup/tree/main/skills/documentation
Command: npx skills add https://github.com/kiryteo/opencode-setup --skill documentation-kiryteo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write clear, maintainable technical documentation for different audiences and purposes.

Core Features & Use Cases

  • Document Types: README, API Documentation, Runbook, Architecture Doc, Onboarding Guide
  • Principles:
    1. Write for the reader
    2. Start with the lede
    3. Show, don't tell
    4. Keep it current
    5. Link, don't duplicate
  • Use Case: Create or update documentation to communicate system designs, installation steps, or onboarding processes.

Quick Start

Create or update a technical document by following the defined document types and structure.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write technical documentation for different audiences?

Technical documentation for different audiences is written by applying principles like writing for the reader and starting with the lede. This ensures READMEs, API docs, and onboarding guides remain clear and audience-specific.

What is the best way to structure an API documentation README?

The best way to structure API documentation and READMEs is by enforcing structured document types and best-practice sections. This approach ensures consistency and usability across end-to-end documentation workflows.

How do I create an onboarding guide and runbook for a new system?

Creating an onboarding guide and runbook involves following defined document types and structure to communicate installation steps and processes. This maintains consistency and shows rather than tells the reader what to do.

Does this approach support maintaining architecture docs alongside end-to-end documentation workflows?

Yes, maintaining architecture docs is supported within end-to-end documentation workflows. It enforces structured document types to ensure system designs and onboarding processes are consistently documented and kept current.

When do I need a runbook versus an architecture doc?

You need a runbook for operational procedures and an architecture doc to communicate system designs. Selecting the correct structured document type ensures the content matches its specific technical purpose and audience.

Why does my technical writing lack consistency across different document types?

Technical writing lacks consistency when structured document types and best-practice sections are not enforced. Applying principles like linking instead of duplicating ensures READMEs and API documentation remain usable and maintainable.