documentation-writing

Guide technical documentation with JSDoc, TSDoc, OpenAPI, and changelog formats.

10|3|Updated Jan 2, 2026
One-click install
npx skills add https://github.com/autohandai/community-skills --skill documentation-writing-autohandai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writing
Source: https://github.com/autohandai/community-skills/tree/main/documentation-writing
Command: npx skills add https://github.com/autohandai/community-skills --skill documentation-writing-autohandai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It provides guidance on technical documentation, JSDoc/TSDoc, OpenAPI, changelogs, and best practices for maintainable docs.

Core Features & Use Cases

  • README Structure and API reference docs
  • JSDoc/TSDoc Examples and inline documentation
  • OpenAPI/OpenAPI-Style Docs and changelog formats

Quick Start

Start documenting a project by aligning code comments with user-facing docs.