JSDoc 文档生成器
为 Effect 公共 API 编写、插入或更新符合规范的 JSDoc,满足 oxlint 规则。
该技能只涉及文档编写,不执行命令或修改文件,权限最小化。验证步骤提示运行 pnpm docgen 和 pnpm lint,但需要用户主动执行。未发现敏感数据处理或外部副作用。来源归属清晰:仓库有 MIT 许可证,但发布者未经验证。因此信任得满分。
技能描述清晰、流程一致,但静态审查无法执行验证。存在测试文件(如 .repos/alchemy-effect 下的集成测试),但并非直接针对此技能。因此可靠性仅给中档,因静态限制不能超过 10。
应用场景明确(编写或修复 Effect 公共 API 的 JSDoc),触发条件精准(解决 jsdocs 诊断、准备 JSON 提取等)。边界明确:不支持模块级注释或默认导出。环境适配上,所有文档操作为本地,无需海外服务,适合中文用户。因此给满分。
信息架构良好,分工作流、格式、规则、审计。提供安装/依赖说明(如 pnpm docgen)。有版本说明(@since 要求)和许可证。但无 changelog 和明确维护者,发布者未验证。因此给满分,因为文档本身很完整,扣分点为维护责任不明确。
从描述看,技能能完成核心任务:生成符合规则的 JSDoc。但静态评估无法验证输出是否直接可用,且该技能主要指导 LLM 生成代码,边际价值不明确。因此给 7,因静态限制不能超过 7。
仓库有 CI 工作流(如 .github/workflows/ci.yml)和测试文件,但并非直接针对此技能。静态审查无法独立复现技能行为,因此不超过 5。
- 未验证发布者身份,需谨慎对待维护承诺。
- 技能只针对 Effect 生态,若用于其他框架可能不适用。
- 验证命令 pnpm docgen 和 pnpm lint 依赖于具体项目配置,可能无法在隔离环境中运行。
这个 Skill 能做什么,适合哪些场景?
该技能用于为 Effect 公共 API 编写、插入或更新 JSDoc 注释,确保符合 jsdocs oxlint 规则。它指导用户按照标准模板组织文档,包括简短描述、使用时机、详情、注意事项和示例,并遵循标签顺序要求。技能提供了详细的散文规则、标签规则、更新现有 JSDoc 的流程,以及模块细化的审计步骤。验证方式包括运行 docgen 和 lint。这个技能来自 T3 Code 仓库,仓库包含多个技能,采用 MIT 许可。
该技能分析 TypeScript 源码中的公共 API 声明,重写或生成 JSDoc 注释,使其符合规定的文档结构。具体包括:识别需要文档化的声明,按照模板组织内容,添加或调整 @category、@since、@see 等标签,将 @example 转换为标准示例块,并运行验证命令(如 pnpm docgen 和 pnpm lint)以确保合规。它还指导用户进行模块级别的细化,包括 @see 和 Gotchas 审计,以改进整体文档质量。
- 当为 Effect 库添加新的公共 API 时,需要生成符合规范的 JSDoc。
- 修复 lint 诊断中关于公共 API JSDoc 缺失或格式错误的问题。
- 准备文档以供 JSON 提取或生成 API 参考时,规范 JSDoc 格式。
- 对现有 Effect 模块进行文档质量改进,包括优化 @see 链接和注意事项。
- 在评审公共 API 文档时,使用该技能检查是否符合组织标准。
这个 Skill 有哪些优点和局限?
- 提供详细的散文和标签规则,确保文档风格一致。
- 包含审计步骤(@see 和 Gotchas)以提高文档质量。
- 专注于 Effect 库,提供针对性的指导。
- 作为更大仓库的一部分,具有潜在的社区支持。
- 适用范围限于 Effect 公共 API,对其他项目可能需调整。
- 验证依赖 pnpm 和已配置的 lint/docgen 环境,可能需额外设置。
- 未提供独立的安装说明,需从仓库中提取。
- 仓库处于早期阶段,不承诺稳定性或贡献支持。
如何安装这个 Skill?
该技能是 T3 Code 仓库的一部分(GitHub: pingdotgg/t3code),仓库采用 MIT 许可。技能文件位于 .repos/effect-smol/.agents/skills/jsdocs/SKILL.md。要使用,需先将仓库克隆或下载,然后按照 Agent Skills 标准将技能文件夹复制到您的代理技能目录中。具体安装步骤未在提供文档中说明。
如何使用这个 Skill?
在代理环境中触发该技能,例如提出请求:“为 Effect 公共 API 添加 JSDoc”或“修复此模块的 JSDoc 以通过 lint”。技能将指导您遵循标准模板进行修改。运行验证时,在包含生成文档的包目录中执行 pnpm docgen,并运行 pnpm lint 检查包含自定义规则的 lint。仅进行散文修改时,无需运行广泛的验证。