What problem does it solve? Technical documentation often ends up inconsistent, verbose, or missing examples, forcing readers to dig through source code to understand an API. This Skill enforces a single team style so every README, CHANGELOG, and JSDoc comment follows the same clear, example-driven format. ## Core Features & Use Cases - README Structure Enforcement: Defines a standard section layout (Installation, Quick Start, API, Configuration) with rules like copy-paste-runnable quick start code and no unrequested badges. - CHANGELOG Formatting: Applies the Keep a Changelog format with categorized entries (Added, Changed, Fixed, Deprecated, Removed, Security) and versioned date headers. - JSDoc Standards: Requires typed @param, @returns, @throws, and mandatory @example tags for public functions, with concrete error types and realistic values. - Use Case: When adding a new public function to a library, ask the agent to document it — the result includes a one-line verb-first summary, typed parameters, a runnable example, and a matching CHANGELOG entry. ## Quick Start Use the documentation-style skill to write a README section and JSDoc comment for the new login function in this project.
