本文へ移動
cccskills
無料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.

pradeepmouli/skillit
インストール方法を見る

含まれるファイル（1）

  • SKILL.md1.1 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインしてレビューを書く

同じリポジトリのスキル

概要と使いどころ

skillit

無料

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

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

skillit-bootstrap

無料

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.

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

skillit-cli

無料

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

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

skillit-cli-docs

無料

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

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

skillit-core

無料

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

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

skillit-docs

無料

Generate AI agent skills from TypeScript documentation

日本語の概要は準備中です。原文の説明を表示しています。

pradeepmouli/skillit72026年10月6日 更新

pradeepmouli のスキルをすべて見る

このスキルの問題を報告する