skills.rest
sf-bcca
sf-bccaCOMMUNITY
Explore all skills by this author →
GitHub

docs-maintainer

Audit AGENTS.md coverage and JSDoc presence in TypeScript/JavaScript modules.

Updated Dec 23, 2025
Search Tags:#typescript#documentation#audit#pre-commit#code-quality#jsdoc#agents.md
One-click install
npx skills add https://github.com/sf-bcca/PromptArchitect-Studio --skill docs-maintainer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-maintainer
Source: https://github.com/sf-bcca/PromptArchitect-Studio/tree/main/.gemini/skills/docs-maintainer
Command: npx skills add https://github.com/sf-bcca/PromptArchitect-Studio --skill docs-maintainer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Audits project documentation to ensure knowledge bases stay current and code is properly documented, preventing missing AGENTS.md entries and undocumented exports.

Core Features & Use Cases

  • Audit Knowledge Base: Checks if all source files in a directory are listed in its AGENTS.md.
  • Check JSDoc: Scans for exported functions/components missing JSDoc comments.
  • Pre-Commit Hygiene: Helps enforce documentation standards before commits and PRs.

Quick Start

Run the audit_knowledge_base.cjs script on a target directory to verify AGENTS.md coverage, then run check_jsdoc.cjs to validate JSDoc presence.

Frequently Asked Questions about docs-maintainer

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

FAQPage Schema
How do I check if my TypeScript source files are listed in AGENTS.md?▼

To check if your TypeScript source files are listed in AGENTS.md, run the audit_knowledge_base.cjs script on the target directory. It verifies source file coverage against the documented knowledge base to ensure no files are missing.

How do I enforce JSDoc comments for exported functions in a JavaScript module?▼

To enforce JSDoc comments for exported functions, run the check_jsdoc.cjs script. It scans your TypeScript and JavaScript modules to identify any exported functions or components that are missing required JSDoc documentation.

Can I run documentation audits as part of my pre-commit hooks?▼

Yes, you can run documentation audits as part of your pre-commit hooks. The scripts enforce documentation hygiene by verifying AGENTS.md references and checking JSDoc presence before you commit code changes.

Do I need an existing AGENTS.md file to audit my project knowledge base?▼

Yes, you need an existing AGENTS.md file to audit your project knowledge base. The audit requires AGENTS.md to exist in applicable directories so it can verify that all source files are properly referenced.

Related Skills

Explore More Software Engineering Skills→
ajoslinajoslin
24

index-knowledge

Generate AGENTS.md documentation at root and subdirectories with complexity scoring.

Community
Advanced
JamesPrialJamesPrial
3

go-linting

Route Go linting tasks to vet, staticcheck, and golangci-lint.

Community
Intermediate
rsnormanrsnorman

quality-check

Run ESLint, Prettier, and TypeScript type checks on code.

Community
Intermediate
ki2pixelki2pixel

scaffold-js-module

Scaffold ES6 modules and frontend services into static directories.

Community
Intermediate