skills.rest
keshavraj936
keshavraj936COMMUNITY
Explore all skills by this author →
Website𝕏@ksavrajshahGitHub

documentation-templates

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

Updated Feb 27, 2026
Search Tags:#changelog#templates#documentation#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/keshavraj936/Pulse-AI --skill documentation-templates-keshavraj936
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/keshavraj936/Pulse-AI/tree/main/Inceptrix/.agent/skills/documentation-templates
Command: npx skills add https://github.com/keshavraj936/Pulse-AI --skill documentation-templates-keshavraj936

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive set of templates and guidelines to ensure consistent, high-quality documentation across all your projects, making them easier to understand, maintain, and contribute to.

Core Features & Use Cases

  • Standardized Templates: Offers ready-to-use Markdown templates for READMEs, API documentation, changelogs, and Architecture Decision Records (ADRs).
  • Code Comment Guidelines: Provides best practices and examples for effective code commenting (JSDoc/TSDoc).
  • AI-Friendly Documentation: Includes guidance on structuring documentation for optimal AI consumption and RAG indexing.
  • Use Case: A new developer joins a project and needs to understand its structure and how to contribute. They can refer to the standardized README and API documentation templates to quickly get up to speed.

Quick Start

Use the documentation-templates skill to generate a README 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
What is the best way to structure project documentation for AI and RAG indexing?▼

Standardized templates provide structured Markdown formats for READMEs, API docs, and changelogs, enforcing scannability and progressive detail. This structure makes content easier for RAG indexing systems to parse and discover.

How do I write a standard README for a new software project?▼

You can generate a README structure using standardized Markdown templates that outline essential project sections. These templates ensure consistent formatting, making it easier for new developers to understand the project and contribute effectively.

What should be included in code comments and API documentation?▼

API documentation and code comments should follow standardized guidelines like JSDoc or TSDoc. Using provided templates ensures comments are effective, structured, and scannable for both human developers and automated tools.

When do I need to create an Architecture Decision Record?▼

You need an Architecture Decision Record when documenting significant structural choices in a software project. Using a standardized ADR template ensures these decisions are recorded consistently for future reference and team alignment.

Can I use these documentation templates for existing codebases?▼

Yes, you can apply these templates to existing codebases to standardize READMEs, changelogs, and API references. They help enforce consistent documentation practices across legacy projects, making them easier to maintain.

Related Skills

Explore More Software Engineering Skills→
memorysavermemorysaver
21

content-documenter

Generate structured Markdown documentation from analyzed media content.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
Kushal9889Kushal9889

initref

Generate and organize project reference documentation from file summaries.

Community
Basic