Habilidades documentation
📚

documentation

Seguro ⚡ Contiene scripts🌐 Acceso a red📁 Acceso al sistema de archivos🔑 Variables de entorno⚙️ Comandos externos

生成 TypeScript 代码文档

También disponible en: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,BfdCampos,sickn33

编写文档会占用编码时间。本技能提供专业的 TSDoc 注释、Storybook 故事、VitePress 指南和 TypeDoc API 参考模板，帮助您更快地完成文档编写。

Soporta: Claude Codex Code(CC)
📊 69 Adecuado
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Pruébalo

Usando "documentation". 为这个获取用户数据的函数添加文档

Resultado esperado:

  • 函数功能的简要说明
  • @param userId - 用户的唯一标识符
  • @returns Promise 解析为用户数据对象
  • @example const user = fetchUserById('123');

Usando "documentation". 为 Button 组件创建 Storybook 故事

Resultado esperado:

  • 标题为 'Components/Button' 的 Meta 配置
  • 不带参数的 default 故事
  • isLoading: true 属性的 loading 变体
  • isDisabled: true 属性的 disabled 变体

Auditoría de seguridad

Seguro
v5 • 1/16/2026

Pure documentation template skill with no executable code. All 53 static findings are false positives: SHA-256 hashes were misidentified as weak crypto, markdown code fences were misidentified as shell execution, and metadata fields were misidentified as security risks. The skill only contains documentation templates for TSDoc, Storybook, VitePress, and TypeDoc.

2
Archivos escaneados
317
Líneas analizadas
5
hallazgos
5
Auditorías totales

Factores de riesgo

⚡ Contiene scripts
No se registraron ubicaciones específicas
🌐 Acceso a red
No se registraron ubicaciones específicas
📁 Acceso al sistema de archivos
No se registraron ubicaciones específicas
🔑 Variables de entorno
No se registraron ubicaciones específicas
⚙️ Comandos externos
No se registraron ubicaciones específicas
Auditado por: claude Ver historial de auditorías →

Puntuación de calidad

38
Arquitectura
100
Mantenibilidad
85
Contenido
20
Comunidad
100
Seguridad
91
Cumplimiento de la especificación

Lo que puedes crear

为导出的函数添加文档

为函数添加包含参数、返回类型和示例的 TSDoc 注释

创建组件故事

为 React 组件编写包含参数和变体的 Storybook 故事

构建 API 参考文档

从 TSDoc 注释生成 TypeDoc API 文档

Prueba estos prompts

为函数添加文档 
为这个函数添加 TSDoc 注释，包含 @param、@returns 和 @example 标签。
创建组件故事 
为这个 React 组件创建一个 Storybook 故事，包含 default、loading 和 error 状态。
为钩子添加文档 
为这个自定义钩子添加 TSDoc 文档，包括选项、返回值和使用示例。
生成 API 文档 
生成 TypeDoc API 文档并更新此组件的 VitePress 侧边栏。

Mejores prácticas

  • 包含带有可运行代码片段的 @example 标签
  • 为所有导出的函数和类型添加文档
  • 在整个代码库中使用一致的 TSDoc 格式
  • 添加 TSDoc 注释后运行 'pnpm docs:api'

Evitar

  • 为复杂函数跳过 @param 或 @returns 标签
  • 编写没有上下文的模糊描述
  • 组件属性更改时忘记更新 Storybook
  • 不运行 TypeDoc 重新生成 API 文档

Preguntas frecuentes

此技能与哪些工具配合使用？
适用于 Claude、Codex 和 Claude Code。支持 TSDoc、Storybook、VitePress 和 TypeDoc。
此技能可以为哪些文件类型添加文档？
支持 TypeScript（.ts、.tsx）文件，包括函数、钩子、组件和接口。
此技能可以分析现有代码吗？
不能。您必须指定要文档化的内容。此技能提供模板，但不会自动提取文档。
我的代码数据安全吗？
是的。此技能只读取、写入和编辑您指定的文件。不会向外部服务发送任何数据。
为什么我的文档没有显示？
运行 'pnpm docs:api' 重新生成 TypeDoc 输出。确保 VitePress 侧边栏包含新文件。
这与 GitHub Copilot 有什么不同？
此技能提供遵循 TSDoc 和 Storybook 标准的结构化文档模板，而不是自动补全代码。

Detalles del desarrollador

Licencia

MIT

Repositorio

https://github.com/CrazySwami/cross-platform-web-app-research/tree/master/.claude/skills/documentation

Ref.

master

Estructura de archivos

📄 SKILL.md