scan-documentation
OfficialAudit code to ensure complete JSDoc coverage.
Authorsncollective
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Ensures that the SNC platform’s codebase has comprehensive JSDoc documentation, preventing undocumented exported APIs, service contracts, shared utilities, and complex React components from slipping through review.
Core Features & Use Cases
- Scans exported functions, service-layer contracts, and shared package exports for missing documentation.
- Reviews React components with three or more props to ensure purpose comments are present.
- References detailed rule specifications stored in the skill’s
references/directory. - Outputs findings formatted for the refactor board’s Fix lane, grouped by file.
Quick Start
Run the scan-documentation skill to produce a list of undocumented items in the SNC repository.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: scan-documentation Download link: https://github.com/sncollective/snc-platform/archive/main.zip#scan-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.