documentation-templates

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

1|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/simoabid/ABID.Dev-Portfolio --skill documentation-templates-simoabid
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/simoabid/ABID.Dev-Portfolio/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/simoabid/ABID.Dev-Portfolio --skill documentation-templates-simoabid

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 clear, prioritized section layout for effective project overviews.
  • API Documentation: Provides a template for documenting individual API endpoints.
  • Code Commenting: Guides on using JSDoc/TSDoc for better code understanding.
  • Changelog & ADRs: Includes templates for tracking changes and architectural decisions.
  • AI-Friendly Docs: Outlines strategies for creating documentation easily consumable by AI agents.
  • Use Case: A new developer joins a project and needs to understand how to contribute or use the API. They can refer to the standardized README and API documentation for quick onboarding.

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 software project?

A standardized README structure provides a clear, prioritized section layout for effective project overviews. It ensures consistency, clarity, and maintainability across projects, which helps new developers quickly understand how to contribute or use the API.

How do I write Architecture Decision Records for my project?

Architecture Decision Records (ADRs) are written using standardized templates that track architectural decisions and changes. This ensures consistent documentation of architectural choices, making it easier for teams to understand the reasoning behind past structural decisions.

What should be included in API documentation templates?

API documentation templates provide a standardized structure for documenting individual API endpoints. They ensure consistent, scannable, and progressively detailed references, facilitating improved project understanding and easier interaction for both developers and AI agents.

How do I format code comments for better project understanding?

Code comments are formatted using JSDoc or TSDoc guidelines provided by standardized templates. This approach ensures consistent, scannable, and progressively detailed documentation, which improves overall code understanding and maintainability across the project.

When do I need AI-friendly documentation formats?

AI-friendly documentation formats are needed when you want AI agents to easily consume and interact with your project documentation. These formats outline specific strategies to create consistent, scannable, and progressively detailed docs for improved AI interaction.

Can I use these documentation templates for tracking project changelogs?

Yes, these documentation templates include specific templates for tracking project changelogs. They facilitate consistent and scannable records of changes, ensuring maintainability and clear communication of updates across the project lifecycle.