skills.rest
DaytimeBlues
DaytimeBluesCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Generate standardized templates for READMEs, API docs, and changelogs.

Updated Jan 31, 2026
Search Tags:#templates#documentation#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/DaytimeBlues/ADHD-CADDI --skill documentation-templates-daytimeblues
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/DaytimeBlues/ADHD-CADDI/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/DaytimeBlues/ADHD-CADDI --skill documentation-templates-daytimeblues

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides standardized templates and guidelines for various documentation types, ensuring consistency, clarity, and maintainability across projects.

Core Features & Use Cases

  • README Structure: Offers a prioritized section breakdown for effective README files.
  • API Documentation: Provides a template for documenting individual API endpoints.
  • Code Commenting: Guides on when and how to write effective code comments using JSDoc/TSDoc.
  • Changelog & ADRs: Includes templates for maintaining a changelog and Architecture Decision Records.
  • AI-Friendly Docs: Outlines strategies for creating documentation optimized for AI consumption.
  • Use Case: A new developer joins a project and needs to understand how to document new features. They can refer to these templates to create a comprehensive README, document new API endpoints, and add clear code comments.

Quick Start

Use the documentation-templates skill to generate a README structure.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I structure a README for my software project?▼

To structure a README effectively, you should follow a prioritized section breakdown that ensures clarity and maintainability. This skill provides standardized templates to help you generate a comprehensive README structure for your project documentation.

What is the best way to document API endpoints and code comments?▼

Documenting API endpoints and code comments effectively requires standardized templates and guidelines. This skill provides structures for individual API endpoints and guides on writing effective code comments using JSDoc or TSDoc.

How do I write an Architecture Decision Record or changelog?▼

Writing an Architecture Decision Record (ADR) or changelog involves using standardized templates to track decisions and changes. This skill includes specific templates for maintaining both changelogs and ADRs to ensure consistent documentation practices.

Can I create AI-friendly documentation formats for my project?▼

Yes, you can create AI-friendly documentation formats by following specific strategies optimized for AI consumption. This skill outlines guidelines to help you structure your project documentation so that it can be easily processed by AI tools.

When do I need standardized templates for project documentation?▼

You need standardized templates for project documentation when you want to ensure consistency, clarity, and maintainability across your software development projects. They are particularly useful when onboarding new developers who need to document new features.

Related Skills

Explore More Software Engineering Skills→
Harvest-Forged-CodeHarvest-Forged-Code
10

documentation-generator

Generate and update project documentation from codebase exploration.

Official
Advanced
DriveConnect-alphaDriveConnect-alpha
1

documentation-templates

Generate standardized markdown documentation templates for new projects.

Official
Intermediate
alfredolopez80alfredolopez80
145

deslop

Remove AI-generated comments, defensive checks, and casts from code branches.

Community
Intermediate
coakenfoldcoakenfold

technical-writer

Generate Markdown documentation from source code and API references.

Community
Intermediate