skills.rest
asarchami
asarchamiCOMMUNITY
Explore all skills by this author →
GitHub

map-project

Generate project-map and symbol-map markdown artifacts documenting Go codebase architecture and interfaces.

1|2|Updated Nov 25, 2017
Search Tags:#onboarding#go#codebase analysis#mermaid diagrams#architecture documentation#project map#symbol index
One-click install
npx skills add https://github.com/asarchami/dotfiles --skill map-project-asarchami
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: map-project
Source: https://github.com/asarchami/dotfiles/tree/main/dot_config/opencode/skills/map-project
Command: npx skills add https://github.com/asarchami/dotfiles --skill map-project-asarchami

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Understanding an unfamiliar Go codebase requires manually reading every package, tracing imports, and reconstructing architecture, which is slow and error-prone for onboarding developers and LLM agents. ## Core Features & Use Cases - Project Map Generation: Produces spec/project-map.md covering five dimensions: package/module map, dependency graph, service overview, data flow, and key interfaces, each with Mermaid diagrams. - Symbol Map Generation: Produces spec/symbol-map.md indexing exported types, functions, and constants across internal/ packages. - Use Case: When joining a Go microservices project, run this Skill to get a complete architecture document with Mermaid mindmaps, flowcharts, sequence diagrams, and class diagrams showing services, ports, and interface implementations. ## Quick Start Ask the AI to map this project and generate the project-map and symbol-map artifacts under the spec directory.

Frequently Asked Questions about map-project

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

FAQPage Schema
How do I generate an architecture overview of a Go codebase?▼

Run this Skill to walk cmd/ and internal/ directories, read package files and imports, and produce spec/project-map.md with Mermaid diagrams covering packages, dependencies, services, data flow, and interfaces.

How to document exported Go symbols across internal packages?▼

The Skill generates spec/symbol-map.md listing exported types, functions, and constants per internal/ package in alphabetical order. Unexported helpers are skipped since they are implementation details.

What diagram types does the project map include?▼

The project map uses five Mermaid diagram types: mindmap for the package tree, flowchart for dependencies and services, sequenceDiagram for data flow paths, and classDiagram for interfaces and their implementations.

Does this work for non-Go projects or other languages?▼

No, the methodology is Go-specific. It relies on cmd/ and internal/ conventions, go list for imports, and Go interface and struct syntax, so other languages would need a different mapping approach.

When should I regenerate the project map artifacts?▼

Regenerate whenever the codebase changes, such as adding packages, services, or interfaces. Each artifact header records the generation date and source commit hash to track staleness.

Related Skills

Explore More Software Engineering Skills→
authgearauthgear
2.0k

update_important_modules

Update stale Go modules in authgear-server repositories with go get -u and go mod tidy.

Official
Intermediate
hohai99hohai99

system-context-extractor

Extracts architectural, business, and operational context from systems into dependency maps and graphs.

Community
Basic
ConsiliencyConsiliency
8

{project}-domain

Codify domain vocabulary and entity relationships for software projects.

Official
Basic
Ritabrata-ChakrabortyRitabrata-Chakraborty

matplotlib

Create and customize static and interactive data visualizations with Matplotlib.

Community
Advanced