Token导航 LogoToken导航TokenDH.com
中转站排行榜
研究检索需要联网github未标认证来源可访问许可证需确认审计通过

code-documentation（代码文档）

Agent Skill

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

总安装

759

周安装

31

GitHub Stars

24

下载量

243
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息，不托管安装包，也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

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

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

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill；本站只展示命令，不托管安装包，也不自动执行。

skills.shnpx skills
npx skills add https://github.com/youdotcom-oss/agent-skills --skill code-documentation

简介

code-documentation 用于辅助文档、README 和 Markdown 内容的整理与改写。

  • 适合提炼结构、补齐章节、统一术语或生成可读说明。
  • 通过 npx skills add 命令从指定 GitHub 仓库安装并使用。
  • 使用时应保留项目已有事实，避免将未确认信息写成确定结论。
  • 适用宿主包括 Codex、Claude、Cursor、Gemini CLI，接入前应确认版本、权限和运行环境要求。

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.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明，方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用；具体调用方式请以来源页面和 README 为准。

平台分布

Codex

38.69%
按下载量换算94

Claude

28.12%
按下载量换算68

Cursor

19.95%
按下载量换算48

Gemini CLI

10.09%
按下载量换算25

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

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

安装前确认

本站仅展示第三方公开信息，不托管安装包，不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源，正式发布前建议补源仓库或其他目录站核验。

来源信息

GitHub 仓库

github.com

/youdotcom-oss/agent-skills

SKILL.md 来源

github.com

/youdotcom-oss/agent-skills/tree/main/skills/code-documentation

skills-sh

skills.sh

/youdotcom-oss/agent-skills/code-documentation

继续浏览同类 Skills

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

上一个 Skill

code-documentation（代码文档）

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

下一个 Skill

code-documentation（代码文档）

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