tomevault-io Research Skill
Deeply investigate a specified area of the codebase and produce a detailed research document.
Usage
/research <target folder, module, or system to investigate>
Workflow
- Deep-read the target area thoroughly — read every file, understand every function, trace every flow
- Write findings to
research.mdin the current working directory
Research Document Structure
Write research.md with the following sections:
- Overview — What this system/module does at a high level
- Architecture — How components are organized, key files and their roles
- Data Flow — How data moves through the system, key interfaces
- Key Implementation Details — Important patterns, conventions, edge cases
- Dependencies — External libraries, internal modules this depends on
- Potential Issues / Observations — Anything noteworthy, inconsistencies, or risks
Critical Rules
- Do NOT implement anything. This phase is research only.
- Do NOT skim. Read files deeply. Understand function bodies, not just signatures.
- Trace call chains end-to-end. Follow imports. Read tests if they exist.
- Write the research document in clear, structured markdown with code references (file:line).
- If the ARGUMENTS specify a bug hunt, keep researching until all bugs are found.
Output
Always write findings to research.md. Never just summarize verbally in chat.
After writing, give a brief summary of key findings to the user.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.