skills.rest
danilomartinelli
danilomartinelliCOMMUNITY
Explore all skills by this author →
Website𝕏@daniloleone429GitHub

documentation-templates

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

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

Core Features & Use Cases

  • README Structure: Offers a prioritized list of essential sections and a template for effective README files.
  • API Documentation: Provides a per-endpoint template for clear and concise API reference documentation.
  • Code Commenting: Outlines best practices and templates for JSDoc/TSDoc comments, distinguishing between necessary and unnecessary comments.
  • Changelog & ADRs: Includes templates for "Keep a Changelog" and Architecture Decision Records (ADRs).
  • AI-Friendly Docs: Defines a structure for llms.txt and principles for RAG-ready documentation.
  • Use Case: When starting a new project, use these templates to quickly set up well-structured README, API docs, and contribution guidelines.

Quick Start

Generate a README file using the provided template.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
What is the best way to structure a README for a new software project?▼

An effective README structure should follow a prioritized list of essential sections to ensure clarity and maintainability. These templates provide a standardized layout focusing on scannability and progressive detail for immediate use.

How do I write API documentation for each endpoint?▼

Writing API documentation requires a per-endpoint template that ensures clear and concise API reference material. The provided guidelines standardize endpoint descriptions, parameters, and responses for consistent and maintainable API docs.

What should code comments include to distinguish between necessary and unnecessary comments?▼

Code comments should follow best practices and templates for JSDoc and TSDoc formats. The guidelines explicitly distinguish between necessary contextual comments and unnecessary redundant statements to maintain a clean codebase.

How do I format a changelog using the Keep a Changelog standard?▼

Formatting a changelog using the Keep a Changelog standard involves utilizing a provided template to record project changes consistently. This ensures up-to-date content and scannability for users tracking version updates.

Can I use these templates to create AI-friendly documentation for RAG indexing?▼

Yes, these templates support AI-friendly documentation by defining a specific structure for llms.txt files. They focus on principles of scannability and progressive detail to optimize content for LLM consumption and RAG indexing.

When do I need to write an Architecture Decision Record and how should it be formatted?▼

An Architecture Decision Record is needed to document significant technical choices, and it should be formatted using a standardized ADR template. This ensures clarity and maintainability across your codebase's architectural decisions.

Related Skills

Explore More Software Engineering Skills→
telum-aitelum-ai
2

project-import

Create a Speck project structure with a skeleton project.md file.

Official
Basic
Sumeet138Sumeet138
1

rag-implementation

Integrate retrieval-augmented generation workflows with vector databases and embeddings.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
bklitbklit
1.5k

wiki-llms-txt

Generate spec-compliant llms.txt and llms-full.txt files from wiki documentation.

Official
Intermediate