docs_code

Enforce JSDoc/TSDoc, inline comments, Keep a Changelog, and Conventional Commits standards.

43|11|Updated Dec 27, 2025
One-click install
npx skills add https://github.com/vuralserhat86/antigravity-agentic-skills --skill docs-code
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs_code
Source: https://github.com/vuralserhat86/antigravity-agentic-skills/tree/main/skills/docs_code
Command: npx skills add https://github.com/vuralserhat86/antigravity-agentic-skills --skill docs-code

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining clear, consistent, and professional code documentation and changelogs, improving code maintainability and team collaboration.

Core Features & Use Cases

  • JSDoc/TSDoc Generation: Learn to write effective documentation comments for JavaScript and TypeScript.
  • Comment Best Practices: Understand when and how to write meaningful inline comments, focusing on the 'why' rather than the 'what'.
  • Changelog Management: Implement the "Keep a Changelog" standard for clear release notes.
  • Conventional Commits: Adopt a standardized commit message format for better version control history.
  • Use Case: Ensure all new features and bug fixes are properly documented with TSDoc, have corresponding changelog entries, and are committed using the Conventional Commits standard, leading to a more organized and understandable project history.

Quick Start

Apply the docs_code skill to generate TSDoc comments for the provided TypeScript function.

Frequently Asked Questions about docs_code

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

FAQPage Schema
What is the best way to write TSDoc comments for TypeScript functions?

Writing TSDoc comments for TypeScript functions involves enforcing best practices for code documentation to improve maintainability. You should focus on effective JSDoc and TSDoc generation to clearly describe function parameters, return types, and behaviors.

How do I generate a changelog using the Keep a Changelog standard?

Generating a changelog using the Keep a Changelog standard involves implementing structured release notes to improve team collaboration. You maintain clear, consistent changelog entries for new features and bug fixes to create an organized project history.

How do I format commit messages using Conventional Commits?

Formatting commit messages using Conventional Commits involves adopting a standardized commit message structure for version control. This ensures better version control history by clearly categorizing changes like bug fixes and new features in your project.

When should I write inline comments in my code?

Writing inline comments should focus on explaining the 'why' rather than the 'what' of your code. Meaningful inline comments enforce coding standards and help software development teams understand complex logic without restating obvious code behavior.

Can I use these documentation standards for JavaScript and TypeScript projects?

Yes, these documentation standards support both JavaScript and TypeScript projects. The practices enforce JSDoc and TSDoc generation, ensuring standardized code documentation and improved code quality across your software development team.