skills.rest
Oscar-Ivan-Salas
Oscar-Ivan-SalasCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Generate README, API docs, and code comment templates with YAML frontmatter.

Updated Jan 27, 2026
Search Tags:#templates#documentation#readme#ai-friendly#guidelines#code-comments#api-docs
One-click install
npx skills add https://github.com/Oscar-Ivan-Salas/PILi_Quarts_Doc --skill documentation-templates-oscar-ivan-salas
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/Oscar-Ivan-Salas/PILi_Quarts_Doc/tree/main/PILi_Quarts_V3.0/.agent/skills/documentation-templates
Command: npx skills add https://github.com/Oscar-Ivan-Salas/PILi_Quarts_Doc --skill documentation-templates-oscar-ivan-salas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Teams struggle with inconsistent docs across projects, leading to onboarding delays and miscommunication. This skill provides standardized documentation templates to align READMEs, API references, and code comments.

Core Features & Use Cases

  • Ready-to-use templates for README, API references, and code comments to accelerate documentation.
  • Structured guidance that maintains consistency across new projects and teams.
  • Use Case: When starting a new project, apply templates to generate a complete documentation skeleton that guides development and onboarding.

Quick Start

Apply the documentation-templates to generate a complete README, API docs outline, and code comments structure for a new project.

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 across multiple projects?▼

Generate a complete documentation skeleton by applying templates that produce a README, API docs outline, and code comments structure, guiding both development and onboarding for a new project.

What is the best way to structure code comments for AI-friendly workflows?▼

Structure AI-friendly code comments using standardized templates that define a repeatable structure with Markdown formatting and YAML frontmatter, enabling consistent references and governance across workflows.

Can I use these documentation templates for existing projects or only new ones?▼

Apply these documentation templates primarily to new projects to generate a complete documentation skeleton, ensuring consistent structure and style from the start and accelerating onboarding workflows.

Does this documentation approach require any specific dependencies or tools?▼

This documentation approach requires no dependencies, using only YAML frontmatter and Markdown templates to define a repeatable structure for standardizing README, API docs, and code comments.

Related Skills

Explore More Content & Communication Skills→
sheldonxxxxsheldonxxxx

git-kb-capture

Capture chat session summaries into a GitHub knowledge base repository.

Community
Advanced
copilot-ldcopilot-ld
1

libdoc

Render Markdown documentation into static HTML sites with Mustache templates.

Official
Advanced
DexploarerDexploarer
7

Railway Deployment Automator

Automate Railway deployments with GitHub, Docker, and CI/CD workflows.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced