document

Name: document
Availability: InStock
Author: lionbenjamin

Update READMEs, API docs, and JSDoc/TypeDoc coverage for code changes.

15|6|Updated Jan 5, 2026

Search Tags:#documentation #readme #jsdoc #api-docs #inline-comments #documentation-quality #typedoc

Ready to run

npx skills add https://github.com/lionbenjamin/agent-templates --skill document-lionbenjamin

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document
Source: https://github.com/lionbenjamin/agent-templates/tree/main/skills/document
Command: npx skills add https://github.com/lionbenjamin/agent-templates --skill document-lionbenjamin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation debt slows teams; this skill helps keep codebases, READMEs, and API docs up to date by enforcing writing and updating docs during changes.

Core Features & Use Cases

Introduce and maintain up-to-date READMEs and API docs alongside code changes.
Generate and verify JSDoc/TypeDoc coverage and alignment with codebases.
Use Case: On a growing project, ensure new features and modules have complete documentation and inline comments.

Quick Start

Run a documentation audit for the latest code changes and generate updated README, JSDoc/TypeDoc, and architecture notes.

Frequently Asked Questions about document

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

FAQPage Schema

How do I keep API docs and READMEs updated when code changes?▼

To keep API docs and READMEs updated during code changes, run a documentation audit against the latest modifications to generate aligned JSDoc, TypeDoc, README, and architecture notes.

How do I enforce JSDoc and TypeDoc coverage for new project modules?▼

Enforce JSDoc and TypeDoc coverage by auditing new modules during development to verify inline comments and API documentation alignment with the codebase before changes are finalized.

What is the best way to maintain technical documentation for onboarding new contributors?▼

The best way to maintain technical documentation for onboarding is to enforce documentation updates alongside code changes, ensuring READMEs and architecture notes accurately reflect the current API surface.

Does this documentation approach work without external dependencies or components?▼

This documentation approach works independently as it relies on no external dependencies or components, directly auditing codebases to enforce documentation quality and alignment.

When do I need to update inline comments and architecture documentation?▼

Update inline comments and architecture documentation whenever code changes, API surface updates occur, or when onboarding new contributors to prevent documentation debt and maintain technical guidance.