Skip to content
cccskills
FreePublished on GitHub

skillit-docs

Documentation conventions for generating high-quality AI agent skills from TypeScript source. Use when preparing a library for skill generation, auditing JSDoc quality, fixing audit warnings, writing @useWhen/@avoidWhen/@never tags, or asking about documentation conventions for skills.

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit
See how to install

Files included (1)

  • SKILL.md1.1 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Documentation Conventions for Skill Generation

Use this skill when improving TypeScript package metadata, README structure, and public JSDoc so typedoc-plugin-skillit can generate better SKILL.md output.

Focus Areas

  • Package metadata: meaningful description, domain keywords, repository URL
  • README shape: opening summary, Features, Troubleshooting
  • JSDoc coverage: summaries, @param, @returns, @remarks, @example
  • Skill routing tags: @useWhen, @avoidWhen, @never, @category

Fix Patterns

  • Prefer problem-oriented summaries over type restatements
  • Write @param prose around caller-visible effects
  • Use @never in NEVER [action] — [reason]. Fix: [recovery path] form
  • Add 3–5 strong @useWhen triggers to important exports

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

skillit

Free

Generate structured AI agent skills (SKILL.md) and llms.txt from your TypeScript API documentation

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

skillit-bootstrap

Free

Bootstrap an AI-agent skill from a TypeScript codebase by running the deterministic skillit generate/audit loop and enriching repo source (JSDoc, README, config-type properties, MCP tool annotations, examples, package.json) until the skill reaches its grade target. Use for cli, typedoc, config, or mcp (build-mode) projects; never edit SKILL.md/references directly.

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

skillit-cli

Free

Extract CLI command structure from commander/yargs for AI agent skill generation Use when working with agent-skills, cli, commander, documentation, skill-generation, yargs.

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

skillit-cli-docs

Free

CLI documentation conventions for generated skills. Use when improving Commander descriptions, help text, positional argument docs, and config-surface correlation.

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

skillit-core

Free

Shared types, SKILL.md renderer, and token budgeting for skillit plugins

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

skillit-docs

Free

Generate AI agent skills from TypeScript documentation

The English summary is being prepared. Showing the original description.

pradeepmouli/skillit7Updated Oct 13, 2026

See all skills by pradeepmouli

Report a problem with this skill