skills.rest
SUN-Underwriting
SUN-UnderwritingOFFICIAL
Explore all skills by this author →
GitHub

documentation-templates

Provide standardized templates for READMEs, API endpoints, and code comments.

Updated Aug 23, 2026
Search Tags:#templates#documentation#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/SUN-Underwriting/SunFlowCRM_DB --skill documentation-templates-sun-underwriting
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/SUN-Underwriting/SunFlowCRM_DB/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/SUN-Underwriting/SunFlowCRM_DB --skill documentation-templates-sun-underwriting

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides standardized templates and guidelines for various documentation types, ensuring consistency, clarity, and maintainability across projects.

Core Features & Use Cases

  • README Structure: Offers a prioritized section breakdown for effective project overviews.
  • API Documentation: Provides a template for documenting individual API endpoints.
  • Code Commenting: Outlines best practices for JSDoc/TSDoc comments and when to use them.
  • Changelog & ADRs: Includes templates for tracking changes and architectural decisions.
  • AI-Friendly Docs: Guides on creating documentation optimized for AI consumption.
  • Use Case: A new developer joins a project and needs to understand how to document new features; they can refer to these templates for consistent READMEs, API docs, and code comments.

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 a README for a new project?▼

An API documentation template provides a structured format for defining individual API endpoints, ensuring comprehensive coverage of request parameters, response schemas, and error codes. This standardization improves project clarity and maintainability.

When do I need to use Architecture Decision Records in software development?▼

Code commenting best practices outline specific scenarios for using JSDoc or TSDoc comments to explain complex logic and define module interfaces. Following these guidelines ensures project documentation remains clear and maintainable for new developers.

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

AI-friendly documentation is created by structuring project docs with clear metadata, standardized templates, and explicit context that AI tools can easily parse. This strategy improves project clarity and ensures AI assistants can effectively understand and use your codebase.

What is the best way to format a changelog for software releases?▼

The best way to format a changelog is using standardized templates that categorize changes by type, such as features, fixes, and breaking changes. This ensures consistency and clarity when tracking changes across project versions.

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
BrunoAMSilvaBrunoAMSilva

markdown-to-html

Convert Markdown files to sanitized HTML with templates.

Community
Intermediate
nanorepublicananorepublica
61

Global Commenting

Apply standardized file headers and module-level comments across codebases.

Community
Basic
tsurutantsurutan

doc-generator

Generate inline and standalone documentation from JavaScript, TypeScript, Python, and Go code.

Community
Intermediate