brownfield-onboarding

Generates structured documentation and improvement recommendations for existing codebases.

1|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/cyberelf/agent_skills --skill brownfield-onboarding
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: brownfield-onboarding
Source: https://github.com/cyberelf/agent_skills/tree/main/skills/brownfield-onboarding
Command: npx skills add https://github.com/cyberelf/agent_skills --skill brownfield-onboarding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides teams in quickly understanding and documenting existing codebases, reducing time-to-productivity when joining brownfield projects.

Core Features & Use Cases

  • Project Discovery & Documentation: Generate an overview of project structure and purpose.
  • Architecture Analysis: Document technical stack and architectural patterns.
  • Design Assessment: Identify design flaws and improvement opportunities.
  • Quality & Automation Review: Assess testing maturity and CI/CD readiness.
  • Use Case: When joining a legacy project, run this skill to produce a structured onboarding package including .onboard/overview.md, architecture.md, and improvement suggestions.

Quick Start

Read the project's README, run the onboarding workflow, and review the generated artifacts in .onboard.

Frequently Asked Questions about brownfield-onboarding

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

FAQPage Schema
How do I onboard to a legacy codebase quickly without getting lost?▼

Brownfield onboarding generates structured documentation including project overview, architecture analysis, and improvement recommendations in a single workflow. Run the skill against your existing codebase to produce actionable artifacts in .onboard/ that accelerate team understanding during handoffs or modernization efforts.

What's the best way to document an existing project's architecture and technical stack?▼

Architecture analysis within brownfield onboarding maps your technical stack, architectural patterns, and design decisions into a single .onboard/architecture.md file. This provides teams with a shared reference during discovery, audit, and modernization phases without manual reverse-engineering.

Can I assess technical debt and CI/CD readiness in an existing project?▼

Yes. Brownfield onboarding evaluates testing maturity, CI/CD pipeline readiness, and identifies design flaws with improvement suggestions. It outputs guardrail reports that surface technical debt and automation gaps for stakeholder review.

When should I use documentation and analysis during project handoffs?▼

Brownfield onboarding is designed for initial project handoffs, technical audits, and modernization efforts. Run it when joining a legacy project to reduce time-to-productivity by generating a structured onboarding package with discovery, architecture, and quality insights upfront.

How does code discovery work for understanding unfamiliar projects?▼

Code discovery analyzes project structure and purpose to generate an overview document. Combined with architecture and design assessment, it creates a complete discovery artifact that helps new team members understand codebase organization and intent without manual exploration.