Token导航 LogoToken导航

Agent Skill · 研究检索

code-documentation（代码文档）

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径，不要把未确认的信息写成确定结论；涉及对外文案时，还需要控制语气，避免过度营销或夸大能力。

code-documentation 是研究检索类 Agent Skill，可用宿主为 Codex、Claude、Cursor、Gemini CLI，通过GitHub 仓库获取，权限为需要联网；许可证为 MIT，第三方扫描已通过，按安装量在研究检索类的 73,675 个 Skill 里排第 55,495。

总安装 475周安装 20GitHub Stars 1下载 166核验 2026-05-01
研究检索需要联网GitHub 仓库未标认证来源可访问许可证明确审计通过CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明，不托管安装包，也不代用户安装。
GitHub
许可证
MIT

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手，先确认命令和权限，再让它执行。

请帮我安装这个 Agent Skill：code-documentation（代码文档）
来源仓库：https://github.com/plaited/development-skills
仓库路径：skills/code-documentation
安装命令：
npx skills add https://github.com/plaited/development-skills --skill code-documentation
安装前请先检查当前环境是否支持对应 CLI，并向我确认将要执行的命令、安装目录、联网范围和文件读写权限；确认后再执行。

命令行安装

复制命令到本机终端执行。不同来源提供的安装方式可能略有差异；本站展示可直接复制的安装命令，安装前请核对来源页面。

skills.shnpx skills
npx skills add https://github.com/plaited/development-skills --skill code-documentation

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题，通常会让助手先检索再总结。

code-documentation 提供 TSDoc 模板和规范，用于维护高质量的类型文档和 API 说明。它反对示例嵌入文档，主张用测试和故事作为活文档，同步更新注释与代码变更。适用于 TypeScript 项目，自动检测过时注释并清理非合规内容，提升文档可用性。

使用前需确保项目已启用类型检查，否则可能因类型推断失败而无法生成准确文档片段。适用宿主包括 Codex、Claude、Cursor、Gemini CLI，接入前应确认版本、权限和运行环境要求。

来源仓库内路径：skills/code-documentation

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI；先确认自己用的是其中之一，再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/plaited/development-skills --skill code-docume…；命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开，让新装的 Skill 被重新扫描到，否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要需要联网，先在测试目录或测试账号里跑，确认没问题再放到正式项目。

常见问题

6 条

code-documentation 怎么安装？

在终端执行 npx skills add https://github.com/plaited/development-skills --skill code-documentation。装完完全退出宿主工具再打开，让它重新扫描本地 Skill。

code-documentation 支持哪些 AI 工具？

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录，一般也能手动放进去，但要自己确认触发方式是否一致。

code-documentation 需要什么权限？

权限级别是需要联网。该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

code-documentation 是免费的吗？

来源标注的许可证是 MIT。本站不代收任何费用，也不托管安装包；能否商用、要不要署名，以许可证原文为准。

code-documentation 用的人多吗？

公开数据是累计安装 475 次，近一周安装 20 次，下载 166 次，GitHub 1 星。这些数字来自第三方目录统计，只能当作热度参考，不代表质量或安全性。

code-documentation 安全吗？

第三方扫描结果为通过，但这只覆盖已知的静态检查项，不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具，换客户端不用重新找替代品。
  • 3 个目录同时收录，说明这个 Skill 流传比较广。
  • 许可证明确为 MIT，商用和分发边界好判断。
  • 第三方扫描已通过，常见的高风险行为没有命中。

先想清楚的地方

  • 第三方目录整理，版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex，想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。
  • 需要许可证清楚、并且有第三方扫描结果的团队项目。

不太适合

  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
code-documentation

代码文档 · 本页

4751需要联网MIT通过

按安装量取同分类前几名；数字来自第三方目录统计，只作热度参考，不代表质量结论。

SKILL.md 原文

Code Documentation Skill

Purpose

This skill provides TSDoc format templates, type documentation guidelines, and maintenance workflows. Use this when:

  • Writing or editing TSDoc comments for any function, type, or module
  • Reviewing documentation quality
  • Creating comprehensive API documentation
  • Documenting complex type structures
  • Cleaning up non-compliant comments (performance notes, timestamps, inline explanations)
  • Synchronizing out-of-sync TSDoc with code changes
  • Removing orphaned documentation for deleted code

Key Standard: No @example sections - tests and stories serve as living examples.

Quick Reference

  • Creating TSDoc: See workflow.md for the generation workflow
  • Maintaining TSDoc: See maintenance.md for cleanup and sync guidelines

This skill contains detailed templates for:

  • Public API Functions
  • Internal Module Documentation
  • Public and Internal Types
  • Helper Functions
  • Behavioral Programming Functions
  • Special Annotations (Security, Performance, Deprecated)
  • Type Documentation (Complex Objects, Unions, Functions, Utilities, Branded Types, etc.)

Navigation

Related Skills

  • typescript-lsp: Use for type verification and discovery during documentation workflow. Essential for Phase 1 (type analysis) and Phase 2 (usage discovery) of the TSDoc generation process. Run lsp-hover to verify signatures, lsp-references to find usages, and lsp-symbols to understand file structure.

平台分布

Claude Code

31.03%
按下载量换算52

windsurf

23.08%
按下载量换算38

OpenCode

15.78%
按下载量换算26

weavefox

12.78%
按下载量换算21

Codex

6.87%
按下载量换算11

Antigravity

3.63%
按下载量换算6

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息，不托管安装包，不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。

继续浏览同类 Skills

更多研究检索 Skills（73,675）返回 Skills 目录

上一个 Skill

code-docs-search-exa（代码文档搜索 EXA）

theishangoswami/code-docs-search-exa

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径，不要把未确认的信息写成确定结论；涉及对外文案时，还需要控制语气，避免过度营销或夸大能力。

下一个 Skill

code-documentation（代码文档）

skillcreatorai/ai-agent-skills

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径，不要把未确认的信息写成确定结论；涉及对外文案时，还需要控制语气，避免过度营销或夸大能力。