investigate-create-doc

Coordinate codebase investigations and generate structured Markdown documentation sets.

Updated Feb 23, 2019
One-click install
npx skills add https://github.com/JohnWebb4/dotfiles --skill investigate-create-doc-johnwebb4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: investigate-create-doc
Source: https://github.com/JohnWebb4/dotfiles/tree/main/.cursor/skills/investigate-create-doc
Command: npx skills add https://github.com/JohnWebb4/dotfiles --skill investigate-create-doc-johnwebb4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This knowledge resource helps teams systematically investigate a codebase topic and convert findings into a structured Markdown documentation set, ensuring that insights are well-organized, reproducible, and easy to share.

Core Features & Use Cases

  • Phase-driven investigation workflow that scopes topics, defines questions, and plans deliverables.
  • Automated generation of a README and per-area sub-documents with cross-links.
  • Supports parallel sub-agents for multi-area deep-dives and maintains evidence-backed deliverables.
  • Use cases include spikes, research, analysis, and documenting how complex code paths operate.

Quick Start

Begin by clarifying the topic and scope, then outline the initial investigation questions and proposed directory structure.

Frequently Asked Questions about investigate-create-doc

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

FAQPage Schema
How do I document codebase investigations and spikes into structured Markdown?

Turn code investigations into structured docs by running a phase-driven workflow that scopes topics and generates cross-linked Markdown documents. It converts research findings into reproducible deliverables.

What is the best way to structure documentation for complex code paths and flows?

Structure documentation for complex code paths by generating a README alongside per-area sub-documents. This maintains cross-linked, evidence-backed deliverables that keep insights organized and shareable.

Can I use parallel sub-agents for multi-area research deep-dives in a codebase?

Yes, you can use parallel sub-agents for multi-area deep-dives during codebase research. This allows simultaneous investigation of multiple components while maintaining evidence-backed deliverables across all generated Markdown files.

How do I plan and scope a codebase analysis before writing documentation?

Plan and scope a codebase analysis by clarifying the topic, defining initial investigation questions, and outlining a proposed directory structure. This frontmatter-defined workflow targets the right components before generating docs.

Does this documentation workflow support optional resource directories and frontmatter metadata?

Yes, the documentation workflow supports optional resource directories and frontmatter-defined metadata. This ensures your codebase analysis remains structured and reproducible while allowing flexibility in how investigation evidence is stored.