⚡

生成组件文档Skill generate-component-documentation

这个技能用于为新的软件组件自动或手动生成详细的文档，包括组件描述、API参考、使用示例和视觉示例，以提高开发效率、确保文档一致性，并帮助开发者快速理解和使用组件。关键词包括：组件文档、文档生成、API文档、前端开发、软件文档、UI组件、代码文档。

前端开发 0 次安装 0 次浏览 更新于 3/23/2026

name: generate-component-documentation description: 为新的组件生成文档。适用于编写文档、记录组件或创建组件文档时使用。

说明

在为新组件生成文档时：

  1. 遵循现有模式：使用 docs 文件夹中找到的文档风格（例如：button.md、accordion.md 等）
  2. 参考实现：基于 crates/story/src/stories 中的同名故事实现来编写文档
  3. API 参考：在适用时，使用 Markdown code 块，并链接到 docs.rs 获取组件 API 参考

示例

生成的文档应包括：

  • 组件描述和用途
  • 属性/API 文档
  • 使用示例
  • 视觉示例（如果适用）