skills.rest
samChang72
samChang72COMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Provide README, API documentation, code comment templates and guidelines for AI-friendly project docs.

1|Updated Feb 2, 2026
Search Tags:#project management#templates#documentation#ai-friendly#guidelines
One-click install
npx skills add https://github.com/samChang72/custom-skills --skill documentation-templates-samchang72
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/samChang72/custom-skills/tree/main/gemini/skills/documentation-templates
Command: npx skills add https://github.com/samChang72/custom-skills --skill documentation-templates-samchang72

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a structured approach to creating comprehensive and AI-friendly documentation for projects, eliminating the guesswork and ensuring consistency across different document types.

Core Features & Use Cases

  • Template-Based Documentation: Offers pre-designed templates for READMEs, API docs, code comments, and AI-friendly documentation.
  • Structured Format Guidelines: Provides clear guidelines for the structure and content of each document type.
  • Use Case: For a software project, this Skill can help establish a standardized documentation process, making it easier for developers and contributors to maintain up-to-date and informative documentation.

Quick Start

Initialize documentation for your project by using the provided templates and guidelines in the 'docs/' directory.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
What are AI-friendly documentation templates and why do I need them for my project?▼

AI-friendly documentation templates provide pre-designed structures for READMEs, API docs, and code comments that eliminate guesswork and ensure consistency across different document types for project maintainers.

How do I create standardized README and API documentation using templates?▼

To create standardized documentation, initialize the provided templates and guidelines in your project's 'docs/' directory. This establishes a consistent and informative documentation process for developers and contributors.

Can I use these documentation templates for existing software projects?▼

Yes, these templates are designed for software projects to help establish a standardized documentation process. They offer pre-designed structures for READMEs, API docs, and code comments that fit existing project workflows.

What's the best way to structure code comments and project guidelines for maintainers?▼

The best way to structure project guidelines is by using pre-designed templates with clear format guidelines for each document type. This structured approach ensures maintainers keep documentation up-to-date and informative.

What types of documentation formats are included in these project templates?▼

The documentation formats included are README files, API documentation, code comments, and AI-friendly documentation. Each format comes with clear guidelines for structure and content tailored for project maintainers.

Related Skills

Explore More Software Engineering Skills→
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic
estevanhernandez-stack-edestevanhernandez-stack-ed
1

generate

Generate codebase documentation scaffolds from project files using vibe-doc CLI.

Community
Advanced
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
RajuNaikRajuNaik
1

api-documentation-generator

Generate OpenAPI specifications and endpoint documentation from source code.

Community
Intermediate