skills.rest
daniel-heydari-dev
daniel-heydari-devCOMMUNITY
Explore all skills by this author →
GitHub

Documentation

Generate README files, JSDoc, API references, and changelogs.

Updated Feb 11, 2026
Search Tags:#changelog#documentation#technical writing#readme#jsdoc#api docs
One-click install
npx skills add https://github.com/daniel-heydari-dev/personal-ai-skills --skill documentation-daniel-heydari-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documentation
Source: https://github.com/daniel-heydari-dev/personal-ai-skills/tree/main/templates/claude/.claude/skills/documentation
Command: npx skills add https://github.com/daniel-heydari-dev/personal-ai-skills --skill documentation-daniel-heydari-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create comprehensive and understandable documentation for your code, APIs, and projects, ensuring users and developers can easily grasp how to use and contribute to your work.

Core Features & Use Cases

  • JSDoc Standards: Enforces best practices for documenting JavaScript/TypeScript code, including parameters, return values, and examples.
  • README Structure: Provides a template for essential sections in a project's README file.
  • API Documentation: Guides on documenting endpoints, including request/response examples and error handling.
  • Inline Comments: Promotes writing explanatory comments that focus on the "why" behind the code.
  • Changelog Format: Adheres to the Keep a Changelog standard for clear release notes.
  • ADR Template: Offers a structure for Architecture Decision Records.
  • Tool Recommendations: Lists useful documentation tools.

Quick Start

Use the documentation skill to generate a README file for a new project.

Frequently Asked Questions about Documentation

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

FAQPage Schema
How do I write a README file that clearly explains my project?▼

A clear README file requires a structured template covering essential sections, ensuring users and developers can easily grasp how to use and contribute to your project. This skill provides that structure.

What is the best way to document JavaScript code using JSDoc?▼

Documenting JavaScript code with JSDoc requires enforcing best practices for parameters, return values, and examples. This skill provides guidelines to create clear, maintainable code documentation.

How do I format a changelog for clear release notes?▼

Formatting a changelog for clear release notes requires adhering to the Keep a Changelog standard. This skill enforces that format to ensure your project maintains a clear and maintainable version history.

What should be included in API documentation for endpoints?▼

API documentation for endpoints should include request and response examples, alongside error handling guidelines. This skill guides you in creating comprehensive and understandable API references.

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

Writing an Architecture Decision Record is needed when you must document significant architectural choices for maintainability. This skill offers a structured template to record these decisions clearly.

How do I write effective inline comments in my code?▼

Effective inline comments should focus on explaining the "why" behind the code rather than the mechanics. This skill promotes writing explanatory comments to ensure your code remains user-friendly.

Related Skills

Explore More Content & Communication Skills→
skyoxuskyoxu

gds-document-project

Analyze existing game projects to generate architecture and component documentation.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
Objective-ArtsObjective-Arts

generate-docs

Generate JSDoc comments and inline comments for codebases.

Official
Intermediate
thimsluggathimslugga

api-documentation-generator

Generate API documentation with endpoints, schemas, and examples from source code.

Community
Intermediate