standard-jsdoc

Generate standard-jsdoc compliant JSDoc for Effect public APIs.

1.6k|107|Updated Feb 15, 2026
One-click install
npx skills add https://github.com/Makisuo/maple --skill standard-jsdoc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: standard-jsdoc
Source: https://github.com/Makisuo/maple/tree/main/.context/effect/.agents/skills/standard-jsdoc
Command: npx skills add https://github.com/Makisuo/maple --skill standard-jsdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineers produce well-formed JSDoc comments for Effect public APIs, ensuring compliance with the standard-jsdoc rules and enabling consistent documentation generation.

Core Features & Use Cases

  • Enforces standard-jsdoc structure, including required sections and ordering.
  • Generates documentation-ready JSDoc for constructors, functions, and types.
  • Prepares content for JSON extraction and API docs review.

Quick Start

Provide a well-formed JSDoc comment for an Effect API following the standard-jsdoc template.

Frequently Asked Questions about standard-jsdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write JSDoc comments for Effect public APIs?▼

To write JSDoc for Effect public APIs, include a short description, dedicated sections in a fixed order, and specific tags like @category and @since following the standard-jsdoc layout for standards-compliant documentation.

What is the standard-jsdoc structure for TypeScript functions and types?▼

The standard-jsdoc structure requires a short description, dedicated sections in a fixed order, and specific tags such as @category and @since to ensure consistent, documentation-ready comments for constructors, functions, interfaces, and types.

How do I generate documentation-ready JSDoc for JSON extraction?▼

Generate documentation-ready JSDoc for JSON extraction by applying the standard-jsdoc template to your API surfaces, ensuring the required sections and tags are properly formatted for API docs review.

Does this JSDoc linting approach apply to TypeScript interfaces and constructors?▼

Yes, this JSDoc linting approach applies to TypeScript interfaces, constructors, functions, and types within the Effect codebase to produce consistent, standards-compliant documentation.

What happens if my JSDoc sections are not in the required fixed order?▼

If JSDoc sections are not in the required fixed order, the documentation fails to conform to standard-jsdoc rules, preventing consistent API documentation generation and successful JSON extraction.