skills.rest
lugassawan
lugassawanCOMMUNITY
Explore all skills by this author →
GitHub

workflow-codebase-knowledge

Generate a structured codebase knowledge document with architecture overview and module map.

2|8|Updated Apr 20, 2026
Search Tags:#architecture overview#codebase onboarding#engineering handoff#module map#read-only analysis#public api surfaces
One-click install
npx skills add https://github.com/lugassawan/swe-workbench --skill workflow-codebase-knowledge
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: workflow-codebase-knowledge
Source: https://github.com/lugassawan/swe-workbench/tree/main/skills/workflow-codebase-knowledge
Command: npx skills add https://github.com/lugassawan/swe-workbench --skill workflow-codebase-knowledge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps you quickly understand an unfamiliar codebase without turning onboarding into a messy, speculative guessing game.

Core Features & Use Cases

  • Architecture overview: Presents a layered mental model of how the system is organized, focusing on boundaries and relationships rather than opinions.
  • Module map & public interfaces: Surfaces entry points and externally-facing APIs (routes, exported symbols, CLI commands, event topics) so you know what you can safely rely on.
  • Conventions and patterns: Extracts recurring practices (error handling style, testing conventions, naming, abstractions) by reading representative files.

Quick Start

Ask the workflow to walk the repository and render a structured codebase knowledge document.

Frequently Asked Questions about workflow-codebase-knowledge

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

FAQPage Schema
How do I get a layered architecture overview of an unfamiliar codebase?▼

Generate a layered architecture overview by performing a read-only sweep of the repository, which maps system boundaries and module relationships into a structured knowledge document without writing to disk.

What is the best way to map public API surfaces during engineering handoff?▼

The best way to map public API surfaces during engineering handoff is to extract entry points, exported symbols, routes, and CLI commands, producing a reliable map of externally-facing interfaces.

Can I scope codebase onboarding to specific directories like src/?▼

Yes, codebase onboarding supports optional path scoping to focus the analysis on specific directories like src/, restricting the module map and architecture review to those targeted repository sections.

Does this codebase analysis tool modify files or report code defects?▼

No, this codebase analysis operates strictly as a read-only sweep with no disk writes, producing a structured knowledge document rather than ranked defect reporting or debug audit outputs.

How do I extract engineering conventions and patterns from a repository?▼

Extract engineering conventions and patterns by reading representative files across the repository to identify recurring practices like error handling styles, testing conventions, naming, and abstractions.

Related Skills

Explore More Software Engineering Skills→
TairitsuaTairitsua
13

third-party-source-catalog

Catalog and fetch third-party library source trees from GitHub repositories and local folders.

Community
Advanced
kaptinlinkaptinlin
23

code-modularizing

Analyzes codebases to identify modularization opportunities and propose phased refactoring plans.

Community
Advanced
kriscendobotkriscendobot
3

coverage-driven-testing

Increase test coverage and identify unreachable code in a monorepo.

Community
Advanced
JansenAnalyticsJansenAnalytics
5

doc-generator

Generate README, JSDoc comments, and API documentation from codebases.

Community
Advanced