agentsclimarketplace
Sign in

Skillit docs

Skill pradeepmouli/skillit/packages/typedoc/skills/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.From its SKILL.md

Install
npx -y skills add pradeepmouli/skillit --skill skillit-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 7 stars7 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.1 KB, 192 tokens by cl100k_base, as published. Nobody here has run it

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

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.