skills.rest
hq-opensource
hq-opensourceOFFICIAL
Explore all skills by this author →
WebsiteGitHub

gsd-mapping

Generates mapping and management documentation for OpenAPI-based web APIs.

7|2|Updated Jun 30, 2025
Search Tags:#architecture#templates#documentation#codebase#conventions#code-review#map
One-click install
npx skills add https://github.com/hq-opensource/predictive-control --skill gsd-mapping
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gsd-mapping
Source: https://github.com/hq-opensource/predictive-control/tree/main/.agent/skills/gsd-mapping
Command: npx skills add https://github.com/hq-opensource/predictive-control --skill gsd-mapping

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams quickly understand an existing codebase by generating architecture, stack, and coding conventions documentation.

Core Features & Use Cases

  • Maps codebases to standardized documents such as ARCHITECTURE.md, STACK.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, INTEGRATIONS.md, and CONCERNS.md.
  • Supports onboarding new developers, planning refactors, and conducting architecture audits across monorepos and multi-language projects.
  • Leverages templates to produce consistent, ready-to-publish documentation that accelerates decision making.

Quick Start

Run the mapping skill against a repository to generate architecture, stack, and conventions documentation.

Frequently Asked Questions about gsd-mapping

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

FAQPage Schema
How do I generate architecture documentation from an existing codebase?▼

To generate architecture documentation from an existing codebase, map the repository to produce structured outputs like ARCHITECTURE.md and STACK.md. This process applies standardized templates to publish ready-to-use docs into a .planning/codebase directory.

What is the best way to document coding conventions across a multi-language monorepo?▼

Documenting coding conventions across a multi-language monorepo involves mapping the diverse codebase to generate standardized CONVENTIONS.md and STRUCTURE.md files. This approach ensures consistent documentation that supports quick onboarding and architecture audits.

Does codebase mapping work for generating testing and integrations documentation?▼

Codebase mapping works for generating testing and integrations documentation by producing standardized TESTING.md and INTEGRATIONS.md files. It analyzes your existing repository to extract structured details on testing frameworks and external integrations.

What are the limitations of using templates for codebase architecture documentation?▼

A limitation of using templates for codebase architecture documentation is that outputs follow a fixed standardized structure like ARCHITECTURE.md and CONCERNS.md. This ensures consistency but may require manual adjustments for highly unconventional project workflows.

Related Skills

Explore More Software Engineering Skills→
remiverdiesenremiverdiesen
6

Ark Analysis

Clone Ark's repository and inspect its architecture, CRDs, and controllers.

Community
Basic
rkz91rkz91
264

gsd-map-codebase

Coordinate parallel gsd-codebase-mapper agents to generate a seven-document codebase map.

Community
Intermediate
VMRam95VMRam95

review-pr

Reviews pull requests for architectural, security, and quality issues.

Community
Advanced
Happyverse-TeamHappyverse-Team

codebase-summary

Analyze a codebase and generate architecture and workflow documentation.

Official
Advanced