skills.rest
hasanraiyan
hasanraiyanCOMMUNITY
Explore all skills by this author →
GitHub

Code Reporting Skill

Generate code-grounded technical reports with Mermaid diagrams and file links.

12|2|Updated Oct 2, 2025
Search Tags:#architecture analysis#mermaid diagrams#codebase research#developer documentation#repository navigation#technical reporting#file linking
One-click install
npx skills add https://github.com/hasanraiyan/resume --skill code-reporting-skill
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Code Reporting Skill
Source: https://github.com/hasanraiyan/resume/tree/main/.agent/skills/code-reporting
Command: npx skills add https://github.com/hasanraiyan/resume --skill code-reporting-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It turns a vague request about how something works into a structured, accurate technical report grounded in the actual repository code.

Core Features & Use Cases

  • Keyword-driven discovery: Identify relevant modules and files by searching the codebase using extracted feature keywords.
  • Traceable deep dive: Read key entry points and follow imports/call flows to explain real behavior, error handling, and security/performance considerations.
  • Professional reporting output: Produce a report with a clear executive summary, Mermaid architecture visuals, and comprehensive functional file links, then persist it to reports/ as a markdown file.
  • Use Case: You want an authoritative explanation of the auth flow for a Next.js app; the skill finds the relevant middleware/controllers, analyzes the flow, links to every referenced file, and saves auth-flow-analysis.md.

Quick Start

Ask the AI to generate a technical report on the auth flow and include clickable file links plus at least one Mermaid diagram, then save it under reports/ as a markdown file.

Frequently Asked Questions about Code Reporting Skill

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

FAQPage Schema
How do I generate technical documentation from a codebase automatically?▼

Generating technical documentation from a codebase involves traversing repository modules to analyze architecture and logic, producing a structured markdown report with Mermaid diagrams and clickable file links saved in the reports directory.

What is the best way to analyze an authentication flow across a repository?▼

The best way to analyze an authentication flow across a repository is by searching feature keywords, reading entry points, and following import flows to explain behavior, culminating in a grounded technical report with functional file links.

Can I include Mermaid architecture diagrams in my developer documentation?▼

You can include Mermaid architecture diagrams in developer documentation by requesting this Skill to process codebase patterns, which outputs structured report sections containing visual diagrams alongside functional absolute file links.

Does this codebase research tool work with Next.js src and components directories?▼

This codebase research tool works with Next.js src, lib, app, components, and api directories by extracting keywords to discover relevant modules and tracing call flows to document real behavior.

How do I create clickable file links with line ranges for codebase analysis reports?▼

Creating clickable file links with line ranges for codebase analysis reports is achieved when the Skill generates functional file:// absolute links pointing directly to referenced code sections within the persisted markdown artifact.

What are the limitations of automated repository navigation for code analysis?▼

A limitation of automated repository navigation for code analysis is that it requires extracting precise feature keywords to discover relevant modules, meaning vaguely specified subsystems may not yield a fully accurate trace of real behavior.

Related Skills

Explore More Software Engineering Skills→
flpbaladaflpbalada
280

project-structure

Organize React/Next.js/TypeScript projects by feature-based architecture.

Community
Basic
hummingbothummingbot
31

slides-generator

Convert Markdown content into PDF slides with Mermaid diagram support.

Official
Advanced
ysyecustysyecust
40

springboot-verification

Verify Spring Boot projects with builds, static analysis, tests, and security scans.

Community
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate