bf-research

Create a structured research report outline for a brownfield code area.

Updated Apr 4, 2026

Search Tags:#architecture #documentation #research #codebase #analysis #reporting #brownfield

Ready to run

npx skills add https://github.com/ricky-yosh/agent-workflows --skill bf-research

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bf-research
Source: https://github.com/ricky-yosh/agent-workflows/tree/main/skills/brownfield/bf-research
Command: npx skills add https://github.com/ricky-yosh/agent-workflows --skill bf-research

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps engineering teams quickly understand a new or existing codebase area by outlining goals, exploring architecture, and producing a structured research note that guides implementation decisions.

Core Features & Use Cases

Define area goals from the spec and identify exploration scope
Inspect key files, entry points, and data flows to build a coherent overview
Produce a draft research report for review and iteration before implementation

Quick Start

Summarize the target code area by generating a draft research report from the spec and codebase.

Frequently Asked Questions about bf-research

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

FAQPage Schema

How do I analyze a brownfield codebase area before starting implementation?▼

Researching existing code architecture involves inspecting entry points, data flows, and key files to build an overview, producing a draft research note that captures goals, scope, and patterns for team review before implementation.

What's the best way to document codebase exploration findings for my engineering team?▼

The best way to document codebase findings is generating a draft research report for team review, iterating based on feedback, then saving the approved report as a research file and generating a separate markdown digest summary.

How do I create a structured research report from a software spec and existing code?▼

You create a structured research report by reading the spec, exploring the relevant code to map data flows and patterns, writing a draft research file, presenting it for user review, and iterating until the report is approved.

Can I review and iterate on a codebase analysis draft before finalizing it?▼

Yes, the research process supports iteration by presenting a draft report for review via user questions, allowing you to refine the area overview and observations until approved, before renaming the draft to a final research file and generating a digest.

What is included in a brownfield codebase research report outline?▼

A brownfield research report outline includes an area overview, key files, data flow, patterns, and observations, systematically capturing the goals and scope of the existing code area to guide engineering implementation decisions.

Does generating a codebase research report require any external dependencies?▼

No external dependencies are required to generate a codebase research report; the process relies solely on reading the spec and exploring the codebase to produce the draft research file and its corresponding digest.