scan-deep

Analyze source code to generate module-level Use Case and User Story documentation drafts.

Updated May 6, 2026
One-click install
npx skills add https://github.com/SuSuSleep/scaffold --skill scan-deep-sususleep
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scan-deep
Source: https://github.com/SuSuSleep/scaffold/tree/main/skills/scan-deep
Command: npx skills add https://github.com/SuSuSleep/scaffold --skill scan-deep-sususleep

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of inconsistent or missing documentation in brownfield projects by automating the creation of module-level Use Case and User Story drafts directly from source code.

Core Features & Use Cases

  • Automated Documentation: Generates structured UC and US drafts by analyzing entry points like route handlers, exported functions, and CLI commands.
  • Workflow Integration: Ensures documentation coverage by tracking progress in a central coverage file and enforcing schema-compliant templates.
  • Use Case: When onboarding a new developer to a legacy module, use this skill to instantly generate a comprehensive overview of the module's entry points, data shapes, and error handling logic.

Quick Start

Run the scan-deep skill to analyze the current module and generate the required documentation drafts.

Frequently Asked Questions about scan-deep

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

FAQPage Schema
How do I generate module-level documentation for legacy source code?

To generate module-level documentation for legacy source code, you can automate the analysis of entry points, data shapes, and error handling patterns to produce structured Use Case and User Story drafts directly from the codebase.

What is the best way to automate Use Case and User Story drafts from existing code?

Automating Use Case and User Story drafts from existing code is best achieved by analyzing source code entry points like route handlers and CLI commands, then enforcing schema-compliant templates to maintain documentation consistency.

How does automated documentation handle coverage tracking in brownfield projects?

Automated documentation handles coverage tracking in brownfield projects by operating within a structured workflow that logs progress in a central coverage file, ensuring no module lacks the required Use Case and User Story drafts.

Can I use automated code analysis to identify data shapes and error handling logic for onboarding?

Yes, you can use automated code analysis to identify data shapes and error handling logic, providing new developers with a comprehensive overview of a legacy module's entry points during onboarding.

Do I need project-specific schema rules to automate technical writing workflows?

Yes, you need project-specific schema rules to automate technical writing workflows, as adherence to these rules enforces coverage tracking and maintains documentation consistency across generated drafts.

What are the limitations of automating module-level documentation from source code?

Limitations of automating module-level documentation include the requirement for strict adherence to project-specific schema rules and a central coverage file, meaning drafts may lack context if the source code lacks clear entry points.