documentation

Generate standardized documentation for React components, API endpoints, and READMEs.

Updated Dec 29, 2025
One-click install
npx skills add https://github.com/dseirz-rgb/worker --skill documentation-dseirz-rgb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/dseirz-rgb/worker/tree/main/.kiro/skills/documentation
Command: npx skills add https://github.com/dseirz-rgb/worker --skill documentation-dseirz-rgb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

文档生成与维护成本高、缺乏统一模板的问题。本技能提供标准化的文档工作流和模板,确保组件、API、模块 README 的文档始终与代码保持同步。

Core Features & Use Cases

  • 模板驱动的文档生成:组件文档、API 文档、模块 README 的自动化模板化生成
  • 一致的文档结构与中英文规范,便于团队协作与对外文档发布
  • Use Case: 为 React 组件编写文档、为 API 端点编写文档、为模块 README 提供完整模板

Quick Start

选择要文档化的对象(组件、API、模块),从 templates 目录复制相应模板,填充名称、参数、示例等信息,然后运行技能的文档生成流程以产出规范化的文档。

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate standardized documentation for React components and API endpoints?

To generate standardized documentation for React components and API endpoints, copy the relevant template from the templates directory, fill in the name, parameters, and examples, then run the documentation generation workflow to produce consistent docs.

What is the best way to maintain consistent project READMEs across multiple modules?

The best way to maintain consistent project READMEs is using template-driven documentation workflows that enforce standardized structures and YAML frontmatter, ensuring module-level guides remain uniform and synchronized with the codebase.

Do I need YAML frontmatter to create API documentation with this workflow?

Yes, you need YAML frontmatter containing a name and description to create API documentation using this workflow, as enforcing this frontmatter standardizes the documentation structure for consistent API references.

Can I use markdown templates for both component documentation and module-level guides?

Yes, you can use markdown templates for both component documentation and module-level guides, enabling consistent doc structure for React components, API endpoints, and module READMEs throughout the documentation lifecycle.

What templates are available for standardizing documentation structure?

Templates are available for React component documentation, API endpoint references, and module READMEs, providing reusable structures that standardize documentation creation from initial generation through to publishing.

Why does my documentation workflow require standardized templates for codebases?

Standardized templates are required to solve high documentation generation and maintenance costs, ensuring component, API, and module docs stay synchronized with the codebase and maintain consistent structure for team collaboration.