skills.rest
BeastAyyG
BeastAyyGCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Generate standardized documentation templates for README, API references, and code comments.

1|Updated Feb 14, 2026
Search Tags:#architecture#templates#documentation#adr#readme#code-comments#api-docs
One-click install
npx skills add https://github.com/BeastAyyG/Campus-Cupids --skill documentation-templates-beastayyg
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/BeastAyyG/Campus-Cupids/tree/main/.agent_backup/skills/documentation-templates
Command: npx skills add https://github.com/BeastAyyG/Campus-Cupids --skill documentation-templates-beastayyg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This collection provides ready-to-use documentation templates to standardize structure and reduce onboarding time for technical projects.

Core Features & Use Cases

  • README Structure Templates: Consistent project introductions and quick-start guides.
  • API Documentation Structure: Clear per-endpoint templates and example blocks.
  • Code Comment Guidelines: Standardized JSDoc/TSDoc patterns and commentary rules.
  • Changelog & ADR Templates: Keep a readable history of changes and decisions.
  • AI-Friendly Documentation: Guidelines for machine-readable docs and indexing.

Quick Start

Follow these templates to quickly scaffold consistent README, API docs, and code comments.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I generate standardized README and API documentation templates for my project?▼

Standardized documentation templates provide consistent README structures and API reference blocks, reducing project onboarding time. They guide teams from quick-start guides to detailed architecture decisions.

What should be included in code comment guidelines and ADR templates for software architecture?▼

Code comment guidelines and Architecture Decision Records (ADRs) standardize JSDoc/TSDoc patterns and track architectural decisions. This ensures consistent commentary rules and a readable history of structural changes across teams.

Can I use these documentation templates for machine-readable and AI-friendly docs?▼

Yes, these templates support AI-friendly documentation by providing guidelines for machine-readable docs and indexing. They ensure technical documentation is structured for both human onboarding and machine parsing.

What is the best way to structure a changelog and API documentation for technical projects?▼

The best way to structure changelogs and API documentation is using standardized templates with clear per-endpoint blocks and example sections. This maintains a readable history of changes and consistent API references.

Does this documentation template collection work without external dependencies?▼

Yes, the documentation template collection operates without external dependencies. It provides ready-to-use scaffolding for README, API docs, code comments, and ADRs without requiring prerequisite modules or components.

Related Skills

Explore More Content & Communication Skills→
samueriosamuerio

readme

Generate README.md files from repository source code and metadata.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
PracticalSwanPracticalSwan
7

documentation-automation

Configure markdownlint, link checkers, and pre-commit hooks for documentation validation.

Community
Intermediate
zenobi-uszenobi-us
68

documentation-engineer

Automate API documentation creation and maintenance with OpenAPI integration.

Official
Advanced