documentation-templates

Name: documentation-templates
Availability: InStock
Author: andrejr82

Generate standardized README, API, and code comment documentation templates.

Updated Feb 6, 2026

Search Tags:#changelog #templates #documentation #readme #code comments #api docs

Ready to run

npx skills add https://github.com/Andrejr82/Caculinha_BI --skill documentation-templates-andrejr82

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/Andrejr82/Caculinha_BI/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/Andrejr82/Caculinha_BI --skill documentation-templates-andrejr82

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides standardized templates and best practices for various types of project documentation, ensuring consistency, clarity, and maintainability across your codebase.

Core Features & Use Cases

README Structure: Offers a prioritized section layout for effective project overviews.
API Documentation: Provides templates for detailing API endpoints, parameters, and responses.
Code Commenting Guidelines: Outlines best practices for JSDoc/TSDoc comments.
Changelog & ADRs: Includes templates for maintaining project history and architectural decisions.
AI-Friendly Docs: Guides on creating documentation optimized for AI consumption.
Use Case: When starting a new project, use these templates to quickly set up a comprehensive README, API documentation structure, and code commenting standards, ensuring all developers follow the same guidelines.

Quick Start

Use the documentation-templates skill to generate a standard README file 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 structure a README for a new software project?▼

To structure a README for a new software project, use a prioritized section layout that provides an effective project overview and ensures consistency. This approach facilitates clear, maintainable documentation across your codebase from the start.

What should be included in API documentation templates?▼

API documentation templates should include detailed sections for API endpoints, parameters, and responses. This standardization ensures your API docs maintain clarity and consistency for developers integrating with your software.

What are the best practices for writing code comments in JavaScript or TypeScript?▼

Best practices for writing code comments in JavaScript or TypeScript involve following standardized JSDoc and TSDoc commenting guidelines. This ensures your codebase remains maintainable and clearly documented across all developers.

How do I write a changelog and record architectural decisions?▼

To write a changelog and record architectural decisions, use standardized templates for maintaining project history and ADRs. This keeps your software development history consistent, up-to-date, and easily scannable.

How do I create AI-friendly documentation for my codebase?▼

To create AI-friendly documentation, apply guidelines that optimize your project docs for AI consumption while adhering to principles of scannability and progressive disclosure. This ensures your information is easily parsed by automated tools.

Do I need any specific dependencies to standardize my project documentation?▼

You do not need any specific dependencies to standardize your project documentation. The templates and guidelines for READMEs, API docs, and changelogs are self-contained and require no external libraries.