documentation-templates

Generate consistent documentation templates for READMEs, API references, and ADRs.

Updated Mar 3, 2025
One-click install
npx skills add https://github.com/cyhinverse/YiBu --skill documentation-templates-cyhinverse
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/cyhinverse/YiBu/tree/main/.agents/skills/documentation-templates
Command: npx skills add https://github.com/cyhinverse/YiBu --skill documentation-templates-cyhinverse

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation teams often struggle with inconsistent structure and outdated templates across READMEs, API docs, code comments, and ADRs. This skill provides canonical templates to standardize these artifacts and accelerate onboarding for new contributors.

Core Features & Use Cases

  • Template Library: Ready-to-use templates for README, API docs, ADRs, and architecture notes.
  • Guidance & Consistency: Clear structure guidelines to maintain uniform quality across projects.
  • Reusable blocks for AI-friendly docs: Modular sections that can be composed per project.

Quick Start

Apply these templates to your project's README, API docs, code comments, ADRs, and architecture notes to standardize documentation.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I standardize README and API documentation structure across multiple software projects?

To standardize README and API documentation structure, you can apply canonical templates that enforce consistent sections and frontmatter metadata. This ensures uniform quality across projects and accelerates onboarding for new contributors.

What is the best way to write consistent architecture decision records (ADRs)?

The best way to write consistent ADRs is to use ready-to-use documentation templates that provide clear structure guidelines. This maintains uniform quality and preserves structured sections for scalable architecture documentation workflows.

Can I use these documentation templates for code comments and architecture notes?

Yes, you can use these documentation templates for code comments and architecture notes. The template library provides modular, reusable blocks that can be composed per project to guide consistent documentation across all software artifacts.

How do I generate AI-friendly documentation with reusable modular sections?

To generate AI-friendly documentation, apply modular template blocks that preserve frontmatter metadata and structured sections. These reusable blocks can be composed per project to maintain scalable documentation workflows.

Do I need any specific dependencies to apply these documentation templates?

No, you do not need any specific dependencies to apply these documentation templates. The skill operates independently to organize and generate structured READMEs, API references, ADRs, and code comments without external requirements.