skills.rest
arroschaves
arroschavesCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-templates

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

1|Updated Sep 25, 2025
Search Tags:#changelog#templates#documentation#api#adr#readme#code comments
One-click install
npx skills add https://github.com/arroschaves/brandaocontador-site --skill documentation-templates-arroschaves
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/arroschaves/brandaocontador-site/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/arroschaves/brandaocontador-site --skill documentation-templates-arroschaves

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 READMEs: Offers a structured template for essential project information.
  • API Documentation: Provides a clear format for documenting API endpoints.
  • Code Commenting: Guides on effective JSDoc/TSDoc usage.
  • Changelog & ADRs: Facilitates clear release notes and architecture decisions.
  • AI-Friendly Docs: Includes a template for llms.txt to aid AI discoverability.
  • Use Case: Ensure all new projects adhere to a consistent documentation standard from day one, improving onboarding for new developers and simplifying AI-driven code analysis.

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
How do I standardize project documentation across multiple repositories?▼

To standardize project documentation, use structured templates for READMEs, API references, code comments, changelogs, and Architecture Decision Records. This enforces scannability, progressive detail, and up-to-date information across all repositories.

What is the best way to format API documentation for AI discoverability?▼

The best way to format API documentation for AI discoverability is using an AI-friendly format like an `llms.txt` file. This aids AI-driven code analysis and improves RAG indexing for your project endpoints.

How do I write effective code comments using JSDoc or TSDoc?▼

Effective code comments using JSDoc or TSDoc follow standardized guidelines that ensure clarity and consistency. These templates guide you on structuring descriptions and parameters to improve maintainability and AI indexing.

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

You need to create an Architecture Decision Record (ADR) when making significant structural choices in a project. Using a standardized ADR template facilitates clear architecture decisions and ensures team alignment.

Can I use these documentation templates for an existing codebase?▼

Yes, you can use these documentation templates for an existing codebase to retroactively standardize READMEs and changelogs. Applying these guidelines improves onboarding for new developers and simplifies maintenance.

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
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
berkcangumusisikberkcangumusisik
11

jsdoc

Generate JSDoc/TSDoc comments for public functions, methods, and types in JavaScript and TypeScript files.

Community
Intermediate
dimsourdimsour
2

dotnet:document

Generate XML documentation, READMEs, and OpenAPI descriptions from .NET source code.

Community
Intermediate