skills.rest
estevanhernandez-stack-ed
estevanhernandez-stack-edCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

scan

Identify and classify project artifacts to generate a prioritized documentation gap report.

1|Updated Apr 15, 2026
Search Tags:#documentation#classification#runbook#scan#gap-analysis#artifact-inventory
One-click install
npx skills add https://github.com/estevanhernandez-stack-ed/Vibe-Doc --skill scan-estevanhernandez-stack-ed
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scan
Source: https://github.com/estevanhernandez-stack-ed/Vibe-Doc/tree/main/packages/vibe-doc/skills/scan
Command: npx skills add https://github.com/estevanhernandez-stack-ed/Vibe-Doc --skill scan-estevanhernandez-stack-ed

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically discovers and analyzes a codebase to reveal missing documentation and gaps, enabling teams to prioritize remediation.

Core Features & Use Cases

  • Artifact inventory and classification to surface project type
  • Generation of a prioritized documentation gap report with risk scoring
  • Intake interview path to capture project context for accurate classification
  • Deterministic, CLI-driven scans for reproducible results

Quick Start

Run vibe-doc scan on your project to start the process and generate a gap report.

Frequently Asked Questions about scan

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

FAQPage Schema
How do I find missing documentation in my codebase?▼

You can find missing documentation by running a deterministic scan to inventory project artifacts, classify their types, and generate a prioritized gap report with risk scoring.

What is a documentation gap analysis and how does it work?▼

A documentation gap analysis identifies and classifies your project artifacts to surface missing docs, capturing project context via intake interviews to generate a prioritized remediation report.

How do I generate a prioritized documentation gap report for my project?▼

Generate a prioritized documentation gap report by initiating a CLI-driven scan on your codebase, which automatically inventories artifacts, scores risks, and outputs a reproducible remediation plan.

Can I use a documentation scan on codebases of various sizes and architectures?▼

Yes, the documentation scan is applicable to codebases of various sizes and architectures, using artifact inventory and classification to accurately surface project types regardless of structural complexity.

What is the best way to classify project artifacts for a runbook inventory?▼

The best way to classify project artifacts for a runbook inventory is through an intake interview path that captures project context, ensuring accurate artifact classification for your gap analysis.

Why does my project need an artifact inventory before generating a gap report?▼

Your project needs an artifact inventory because identifying and classifying artifacts is the required mechanism to surface the actual project type and accurately prioritize missing documentation gaps.

Related Skills

Explore More Software Engineering Skills→
PolliticalSolutionsPolliticalSolutions

demand-intake

Collect and structure legal inputs for demand letter intake.

Community
Intermediate
anthropicsanthropics
9.1k

gaps

Report open remediation gaps from gap-tracker.yaml and update their status.

Official
Intermediate
yulonghe97yulonghe97
8

import

Scan a codebase and generate a ystack module registry, progress files, and a documentation gap report.

Community
Advanced
vasilyu1983vasilyu1983
73

qa-docs-coverage

Audit codebases to identify documentation gaps and generate coverage reports.

Community
Advanced