skills.rest
cy-wali
cy-waliCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Generate and maintain technical documentation across READMEs, API docs, and runbooks.

1|Updated Mar 19, 2026
Search Tags:#documentation#onboarding#readme#runbook#technical-writing#api-docs
One-click install
npx skills add https://github.com/cy-wali/knowledge --skill documentation-cy-wali
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/cy-wali/knowledge/tree/main/engineering/skills/documentation
Command: npx skills add https://github.com/cy-wali/knowledge --skill documentation-cy-wali

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and maintaining technical documentation is time-consuming and prone to becoming outdated. This Skill provides a structured approach to generate, organize, and keep documentation up-to-date across READMEs, API docs, runbooks, and architecture notes.

Core Features & Use Cases

  • Generate README templates tailored to project goals and audiences.
  • Create API reference style docs with endpoints, examples, and error codes.
  • Produce runbooks and onboarding guides to accelerate team ramp-up and incident response.

Quick Start

Create a complete README and API documentation set for a new module using the project’s documentation templates.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate a README and API documentation set for a new module?▼

Generate technical documentation by applying structured templates with organized frontmatter to produce consistent READMEs and API references tailored to your new module.

What is the best way to write runbooks and onboarding guides for engineering teams?▼

The best way to create runbooks and onboarding guides is to use a structured documentation approach that applies scalable templates to accelerate team ramp-up and incident response.

How do I create API reference docs with endpoints, examples, and error codes?▼

Create API reference docs by applying structured templates that organize endpoints, examples, and error codes into a consistent, maintainable format for engineering teams.

Can I use these documentation templates for architecture diagrams and notes?▼

Yes, you can apply these documentation templates to architecture diagrams and notes, as the Skill supports generating and maintaining architecture notes alongside READMEs and API docs.

How do I keep technical documentation up-to-date and prevent it from becoming outdated?▼

Keep technical documentation up-to-date by applying a structured approach to generation and maintenance, ensuring READMEs, API docs, and runbooks remain consistent and current.

What are the limitations of using templates for technical writing?▼

The limitation of using templates for technical writing is that output consistency depends on providing accurate project goals and audience context to generate tailored READMEs and API references.

Related Skills

Explore More Software Engineering Skills→
sunLeeesunLeee

doc-spec

Transform PRDs into technical specifications with API definitions, data models, and sequence diagrams.

Community
Advanced
tomada1114tomada1114
4

video-script-writing

Generate structured YouTube scripts from Markdown articles, notes, or outlines.

Community
Basic
jolequesjoleques

api-documentador-revisor

Validate API documentation completeness and consistency, then produce a Markdown revision report.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate