skillit-docs

Audit TypeScript JSDoc, README, and package metadata for skill generation.

7|3|Updated Mar 21, 2026
One-click install
npx skills add https://github.com/pradeepmouli/skillit --skill skillit-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skillit-docs
Source: https://github.com/pradeepmouli/skillit/tree/main/packages/typedoc-plugin/skills/skillit-docs
Command: npx skills add https://github.com/pradeepmouli/skillit --skill skillit-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps authors turn TypeScript source documentation into strong AI agent skills by improving the prose, structure, and metadata that skill generators rely on.

Core Features & Use Cases

  • Documentation Auditing: Review JSDoc, README content, and package metadata for issues that weaken skill generation.
  • Skill-Quality Guidance: Apply conventions for descriptions, examples, decision notes, anti-patterns, and recovery paths that make generated skills more useful to LLMs.
  • TypeScript Library Preparation: Use it when preparing a library for skill generation, fixing audit warnings, or adding expert tags like @useWhen, @avoidWhen, and @never.
  • Use Case: A team wants to generate a polished SKILL.md from a TypeScript package; this Skill tells them exactly what to change in the source docs so the resulting skill is more discoverable and reliable.

Quick Start

Ask this skill to audit your TypeScript documentation and recommend the exact JSDoc, README, and package metadata changes needed to produce a higher-quality skill.

Frequently Asked Questions about skillit-docs

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

FAQPage Schema
How do I audit TypeScript JSDoc and README content for AI skill generation?

To audit TypeScript documentation for skill generation, review JSDoc comments, README structure, and package metadata for missing descriptions or incomplete exports that weaken AI agent skill quality and discovery signals.

What JSDoc tags improve TypeScript library preparation for AI agents?

Expert JSDoc tags like @useWhen, @avoidWhen, @never, @throws, and @remarks improve TypeScript library preparation by providing AI agents with decision notes, anti-patterns, and recovery paths for reliable skill generation.

Why does my generated AI skill have weak discovery signals from TypeScript docs?

Generated AI skills have weak discovery signals when TypeScript package metadata lacks descriptive fields, export documentation is incomplete, or JSDoc lacks expert tags like @useWhen and @avoidWhen that guide agent behavior.

What is the best way to structure TypeScript documentation for skill generation?

The best way to structure TypeScript documentation for skill generation is ensuring complete export documentation, descriptive package metadata, and applying skill-writing conventions for examples, anti-patterns, and recovery paths.

Do I need TypeDoc to prepare a TypeScript package for AI skill generation?

TypeDoc can assist with extracting TypeScript documentation, but preparing a package for skill generation specifically requires auditing JSDoc, README content, and package metadata to add expert tags and ensure complete export coverage.