JSDoc Generator
Write, insert, or update Effect public API JSDoc to satisfy the jsdocs oxlint rule.
The skill only involves documentation writing, no command execution or file modification, least privilege. Validation steps mention running pnpm docgen and pnpm lint, but require user action. No sensitive data handling or external effects. Source attribution clear: MIT license in repo, but publisher unverified. Thus full trust score.
Skill instructions are clear and consistent, but static review cannot execute validation. There are test files (e.g., integration tests under .repos/alchemy-effect), but not directly for this skill. Thus middle score, static cap at 10.
Clear use case (write or fix JSDoc for Effect public APIs), precise triggers (resolve jsdocs diagnostics, prepare for JSON extraction). Boundaries clear: module-level comments and default exports not supported. Environment fit: all local operations, no overseas services, suitable for Chinese users. Thus full score.
Good information architecture with workflow, formats, rules, audits. Provides install/dependency notes (e.g., pnpm docgen). Versioning guidance (@since requirements) and license. But no changelog and unclear maintainer, publisher unverified. Thus full score because docs are comprehensive, deduction for unclear maintenance responsibility.
From description, skill can complete core task: generate JSDoc compliant with rules. But static assessment cannot verify output directly usable, and since it guides LLM to generate code, marginal value unclear. Thus 7, static cap at 7.
Repo has CI workflows (e.g., .github/workflows/ci.yml) and test files, but not directly for this skill. Static review cannot independently reproduce skill behavior, so cap at 5.
- Publisher identity unverified; treat maintenance promises with caution.
- Skill is specific to Effect ecosystem; may not apply to other frameworks.
- Validation commands pnpm docgen and pnpm lint depend on project-specific config and may not run in isolation.
What does this skill do, and when should you use it?
This skill guides writing, inserting, or updating JSDoc for Effect public APIs, ensuring compliance with the jsdocs oxlint rule. It enforces a standard documentation template including short description, when-to-use, details, gotchas, and examples, with specific tag ordering. The skill provides detailed prose rules, tag rules, processes for updating existing JSDoc, and module refinement audits. Validation involves running docgen and lint. It is part of the T3 Code repository, which bundles multiple skills, licensed under MIT.
The skill analyzes TypeScript public API declarations, rewrites or generates JSDoc comments to conform to the required structure. It identifies declarations needing documentation, organizes content into a standard template, adds or adjusts tags like @category, @since, @see, and converts @example tags into standard example blocks. It also instructs running validation commands (pnpm docgen and pnpm lint) to verify compliance. For module refinement, it guides @see and Gotchas audits to improve overall documentation quality.
- Adding JSDoc to new public APIs in an Effect library.
- Fixing lint diagnostics about missing or malformed JSDoc on public APIs.
- Preparing documentation for JSON extraction or API reference generation.
- Improving documentation quality of an existing Effect module, including @see links and gotchas.
- Reviewing public API documentation to ensure it meets organizational standards.
What are this skill's strengths and limitations?
- Provides detailed prose and tag rules for consistent documentation style.
- Includes audit steps (@see and Gotchas) to improve documentation quality.
- Focused on Effect library, offering tailored guidance.
- Part of a larger repository with potential community support.
- Limited to Effect public APIs; may need adjustments for other projects.
- Validation depends on pnpm and a configured lint/docgen environment, which may require setup.
- No standalone installation instructions; must be extracted from repository.
- Repository is early stage, with no commitment to stability or contributions.
How do you install this skill?
The skill is part of the T3 Code repository (GitHub: pingdotgg/t3code), licensed under MIT. The skill file is located at .repos/effect-smol/.agents/skills/jsdocs/SKILL.md. To use, clone or download the repository, then copy the skill folder into your agent's skills directory according to the Agent Skills standard. Specific installation steps are not detailed in the provided documentation.
How do you use this skill?
Invoke the skill in your agent environment with a request like "Add JSDoc for Effect public API" or "Fix JSDoc for this module to pass lint." The skill will guide you through modifying the docs according to the standard template. For validation, run pnpm docgen from the package directory if docs are generated, and run pnpm lint to check the custom rule. For prose-only changes, broad validation is not needed.