research-report

Generate a structured codebase research document with file:line references.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/aldengolab/lorist --skill research-report-aldengolab
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: research-report
Source: https://github.com/aldengolab/lorist/tree/main/skills/research-report
Command: npx skills add https://github.com/aldengolab/lorist --skill research-report-aldengolab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces a purely descriptive technical map of a codebase, documenting what exists, where it lives, and how it connects — without evaluating or suggesting changes.

Core Features & Use Cases

  • Pure descriptive mapping: enumerates code structure, directories, and key interfaces with explicit file:line references.
  • Navigation & documentation: outlines how components connect, data flows, and dependencies to enable future work without modifying code.
  • Use cases: when starting a new feature, onboarding a new team member, or conducting upfront architecture studies to understand scope.

Quick Start

Provide a path to the codebase and I will generate a structured research document with file:line references.

Frequently Asked Questions about research-report

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

FAQPage Schema
How do I map a codebase to understand its architecture before adding a feature?

Mapping a codebase involves enumerating directories, key interfaces, and component connections with file:line references. This generates a structured markdown document detailing what exists and how dependencies flow, enabling you to understand scope before modifying features.

What is the best way to document code structure for onboarding new team members?

The best way to document code structure for onboarding is generating a descriptive technical map with explicit file:line references. This outlines how components connect and data flows without modifying code, producing a navigable research document for new developers.

Can I use this to generate architecture documentation without evaluating or suggesting changes?

Yes, you can generate architecture documentation that is purely descriptive and explicitly avoids evaluation or suggestions. It documents what exists, where it lives, and how components connect, providing a neutral technical map for your research.

Does the generated research document include file and line references for code navigation?

Yes, the generated research document includes explicit file:line references throughout its structured areas. This ensures precise code navigation by mapping exactly where components exist and connect within the codebase directories and interfaces.

When do I need a descriptive codebase map instead of a code review?

You need a descriptive codebase map when starting a new feature, onboarding a team member, or conducting upfront architecture studies to understand scope. Unlike a code review, it purely documents what exists and how components connect without evaluating or suggesting changes.