Generate AI-first JSDoc headers for TypeScript functions, classes, and hooks.
npx skills add https://github.com/joaoporth/ai-skills --skill ai-docs-joaoporth
Please help me install this Agent Skill. Skill: ai-docs Source: https://github.com/joaoporth/ai-skills/tree/main/ai-docs Command: npx skills add https://github.com/joaoporth/ai-skills --skill ai-docs-joaoporth
This Skill provides an AI-first JSDoc convention for TypeScript code documentation, enabling AIs to understand business rules, side effects, and decisions without prior context.
Install the ai-docs skill and use it to document a new function in your TypeScript code.
High-intent search queries and answers about installing and using this skill.
AI-first JSDoc provides inline TypeScript documentation that embeds business rules, side effects, and decisions directly in code headers, enabling AIs to understand context without prior conversation.
Generating JSDoc for TypeScript functions and classes involves applying a standardized convention that covers components, hooks, types, enums, and business-rule constants to automate inline documentation and improve readability.
To prevent JSDoc doc rot when refactoring TypeScript, you must edit the code and update the JSDoc headers in the exact same edit, ensuring documentation stays synchronized with logic changes.
Yes, this AI-first documentation convention works without dependencies, providing standalone scripts and references to establish JSDoc patterns for TypeScript code without requiring external libraries.
Including side effects and error scenarios in TypeScript documentation reduces errors during refactoring and maintenance by clearly communicating business rules and unexpected behaviors to both humans and AI assistants.
The best way to document TypeScript enums and business-rule constants is using a standardized JSDoc convention that captures their specific business logic and decision context for AI processing.
tacogipsEnforce strict TypeScript coding standards for type safety and error handling.
Asymmetric-alLint and validate Node.js, TypeScript, and Python code for syntax and standards.
DavidKkEnforce consistent TypeScript/React JSDoc formatting and English-only comments.
miounet11Generate and improve code documentation across JSDoc, README, and API specs.
