skills.rest
Durannd
DuranndCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-templates

Generate templates for READMEs, API references, changelogs, and code comments.

Updated May 3, 2026
Search Tags:#templates#documentation#API#guidelines#write#tech writing
One-click install
npx skills add https://github.com/Durannd/skills --skill documentation-templates-durannd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/Durannd/skills/tree/main/skills/documentation-templates
Command: npx skills add https://github.com/Durannd/skills --skill documentation-templates-durannd

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides structured templates and guidelines that help users create clear, consistent, and comprehensive documentation across various formats.

Core Features & Use Cases

  • Documentation Structuring: Templates for README, API docs, changelogs, and architecture decisions.
  • Code Comments: Standardized comment styles to improve code readability and maintainability.
  • AI-Friendly Docs: Specialized formats optimized for AI parsing and knowledge extraction.
  • Use Case: A developer wants to accelerate onboarding by applying these templates to new projects, ensuring all documentation follows best practices.

Quick Start

Use this Skill to generate a README template for your new project and adapt it to your needs.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I structure project documentation like a README for new codebases?▼

Standardized documentation templates provide structured guidelines for READMEs, API references, and changelogs, ensuring your project documentation remains clear, consistent, and professional across new codebases.

What is the best way to write API references and changelogs?▼

Standardized templates enforce consistent formatting and guidelines for API references and changelogs, improving code readability and ensuring clear technical communication across your project.

How do I write code comments that improve readability and maintainability?▼

Standardized code comment templates provide consistent style guidelines designed to enhance code readability and maintainability, ensuring clear technical communication across your development team.

Can I create AI-friendly documentation structures for knowledge extraction?▼

Yes, specialized templates provide AI-friendly documentation formats optimized for AI parsing and knowledge extraction, ensuring your technical docs are structured for automated processing.

Does this technical writing skill support architecture decision records?▼

Yes, the technical writing templates support architecture decision records alongside READMEs, API docs, and changelogs, providing structured guidelines for comprehensive project documentation.

Related Skills

Explore More Content & Communication Skills→
GeargrindadminGeargrindadmin

documentation-templates

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

Community
Basic
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
yasushiasahiyasushiasahi

Quality Tools

Execute standardized linting workflows for multiple languages and tools, including ESLint-based TypeScript checks with configurable severity thresholds and remediation options.

Community
Intermediate
wyhlovecppwyhlovecpp

document-writer

Convert code repositories into structured technical documents and API references.

Community
Intermediate