What documentation types are included in this skill?

It includes templates for READMEs, API references, Changelogs, Architecture Decision Records (ADRs), and code comments.

Why should I use the ADR template?

Architecture Decision Records (ADRs) document the context and consequences of technical decisions, providing vital historical context for future maintainers.

Does it support specific programming languages for comments?

The skill includes specific templates for JSDoc and TSDoc, which are common standards for JavaScript and TypeScript, but the principles apply broadly.

How does this make my project AI-friendly?

It provides structures like llms.txt and MCP-ready patterns that help AI crawlers and RAG systems index your code and documentation more effectively.

Can I customize the provided templates?

Yes, the templates serve as standardized starting points that are intended to be adapted to your project's specific needs and scale.

Documentation Templates & Guidelines

Name: Documentation Templates & Guidelines
Author: CarlosVerasteguii

byCarlosVerasteguii

0•

Content Management

Standardizes project documentation using templates for READMEs, API references, code comments, and AI-optimized formats.

The Documentation Templates skill provides a comprehensive framework for creating high-quality, professional technical documentation. It offers structured templates for essential project files like READMEs and changelogs, guidelines for clear API documentation and JSDoc comments, and modern formats like llms.txt and MCP-ready structures to ensure your project is readable by both humans and AI agents. This skill is ideal for developers who want to maintain consistency across their codebase and improve the discoverability and usability of their projects.

Key Features

01Best-practice guidelines for JSDoc/TSDoc code commenting and business logic explanation.

02Standardized README and Changelog templates for consistent project presentation.

03AI-friendly documentation patterns including llms.txt and MCP-ready indexing.

04Architecture Decision Record (ADR) templates for tracking technical evolution.

050 GitHub stars

06Detailed API documentation structures for REST and service interfaces.

Use Cases

01Optimizing project documentation for AI crawlers and Large Language Model indexing.

02Auditing and improving existing codebase comments and API references for better maintainability.

03Bootstrapping a new project with professional, industry-standard documentation files.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add carlosverasteguii/daticket documentation-templates

For use in Claude.ai and ChatGPT

Download Skill