code-reporting

Generates structured technical reports by exploring and analyzing codebase files.

Updated Jul 26, 2026
One-click install
npx skills add https://github.com/Dhruv-Ghanchi/Portfolio-Webiste --skill code-reporting-dhruv-ghanchi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-reporting
Source: https://github.com/Dhruv-Ghanchi/Portfolio-Webiste/tree/main/.agent/skills/code-reporting
Command: npx skills add https://github.com/Dhruv-Ghanchi/Portfolio-Webiste --skill code-reporting-dhruv-ghanchi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Producing accurate, well-structured technical documentation about a codebase requires manually tracing files, understanding logic flows, and formatting findings, which is slow and error-prone. ## Core Features & Use Cases - Guided Codebase Exploration: A defined workflow for keyword search, directory listing, and file reading to trace how components interact before writing anything. - Standardized Report Structure: Enforces a professional format with executive summary, Mermaid architecture diagrams, deep-dive analysis, and recommendations. - Verified File References: Requires every mentioned file to be a clickable file:/// link with absolute paths and optional line ranges. - Use Case: Ask for a report on the authentication flow, and receive a persisted Markdown document in reports/ with diagrams, linked source files, and actionable recommendations. ## Quick Start Ask the assistant to generate a technical report on a specific feature such as the chatbot architecture or auth flow in this repository.

Frequently Asked Questions about code-reporting

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

FAQPage Schema
How do I generate a technical report about my codebase?

Request a report on a specific topic such as the auth flow or chatbot architecture. The skill searches the codebase with grep and directory listing, reads the relevant files, traces the logic, and produces a structured Markdown report saved in a reports directory.

What structure does a code analysis report follow?

Each report contains a title and executive summary, an architectural overview with Mermaid diagrams, a deep-dive analysis of code patterns and security considerations, linked file references, and a recommendations section.

How are source files referenced in the generated report?

Every mentioned file must be a clickable Markdown link using the file:/// URI scheme with an absolute path. Specific sections can include line ranges, for example filename:L10-20 pointing to lines 10 through 20.

Where are generated code reports saved?

Reports are persisted as Markdown files in a reports directory created at the project root. Each file gets a descriptive name such as reports/auth-flow-analysis.md so it remains accessible in the codebase.

What are the limitations of automated codebase reporting?

Report quality depends on the search keywords and files actually read during exploration. Large or poorly organized repositories may require narrower topic scoping, and diagrams reflect only the code paths that were traced.