skills.rest
jvsandhu
jvsandhuCOMMUNITY
Explore all skills by this author →
GitHub

docs_code

Writes JSDoc/TSDoc comments, changelogs, and conventional commit messages for codebases.

Updated Jan 14, 2026
Search Tags:#changelog#documentation#conventional commits#code comments#semver#jsdoc#tsdoc
One-click install
npx skills add https://github.com/jvsandhu/agentic-skills --skill docs-code-jvsandhu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs_code
Source: https://github.com/jvsandhu/agentic-skills/tree/main/skills/docs_code
Command: npx skills add https://github.com/jvsandhu/agentic-skills --skill docs-code-jvsandhu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases often lack consistent inline documentation, structured changelogs, and standardized commit messages, making maintenance and collaboration harder over time. ## Core Features & Use Cases - JSDoc/TSDoc Standards: Provides templates for documenting exported functions and classes with @param, @returns, and @example blocks. - Comment Best Practices: Distinguishes useful "why" comments from redundant "what" comments, including business-logic annotations. - Changelog & Commit Standards: Applies Keep a Changelog format with SemVer versioning and Conventional Commits (feat, fix, docs, refactor). - Use Case: When preparing a release, use this Skill to document all public APIs with TSDoc, update the changelog under the correct SemVer version, and format commit messages consistently. ## Quick Start Document this TypeScript module with TSDoc comments and draft a changelog entry for version 1.2.0 following Keep a Changelog format.

Frequently Asked Questions about docs_code

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

FAQPage Schema
How do I write JSDoc comments for TypeScript functions?▼

Use TSDoc block comments starting with /** before each exported function, including @param for each argument, @returns for the output, and @example for usage. This makes documentation appear in IDE hover tooltips.

What is the Keep a Changelog format?▼

Keep a Changelog organizes release notes under version headers with ISO 8601 dates, grouping entries into Added, Changed, Deprecated, Removed, Fixed, and Security categories. New changes go under an Unreleased header until versioned.

How do conventional commits work with SemVer?▼

Conventional Commits use prefixes like feat:, fix:, docs:, and refactor: with an optional scope such as feat(auth):. Feat commits map to minor SemVer bumps, fix commits to patch bumps, and breaking changes to major bumps.

When should I write code comments versus self-documenting code?▼

Write comments that explain why code exists, such as business rules or workarounds, rather than restating what the code does. Prefer clear naming for the what, and reserve comments for context like ticket references or optimization rationale.

Does TSDoc work with JavaScript projects?▼

Yes, JSDoc/TSDoc comments work in plain JavaScript files and are recognized by editors like VS Code for IntelliSense and type hints. TypeScript projects get additional type checking benefits from the same comment syntax.

Related Skills

Explore More Software Engineering Skills→
mvillmowmvillmow
18

generate-api-docs

Generate HTML or Markdown API reference docs from docstrings.

Community
Intermediate
AnthonyPoschenAnthonyPoschen
2

release

Generate changelogs, release notes, and version tags following repository conventions.

Community
Intermediate
DataDogDataDog
648

lint

Run Hatch-based lint, format, and quality checks on modified files.

Official
Advanced
maggitmaggit

apidoc

Generate Markdown and OpenAPI documentation from source code and route definitions.

Community
Advanced