跳到正文
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.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md1.1 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

skillit

免费

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

中文简介正在准备中。当前显示原文说明。

pradeepmouli/skillit72026年10月19日 更新

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月19日 更新

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月19日 更新

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

中文简介正在准备中。当前显示原文说明。

pradeepmouli/skillit72026年10月19日 更新

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

中文简介正在准备中。当前显示原文说明。

pradeepmouli/skillit72026年10月19日 更新

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. Use this even if the user just says 'audit my docs', 'improve my JSDoc', or 'make my skills better'.

中文简介正在准备中。当前显示原文说明。

pradeepmouli/skillit72026年10月19日 更新

查看 pradeepmouli 的全部技能

报告此技能的问题