Skip to content

READING-GUIDES.md

Latest commit

 

History

History
63 lines (41 loc) · 3.24 KB

READING-GUIDES.md

File metadata and controls

63 lines (41 loc) · 3.24 KB
Raw

Reading Guides

Per-persona entry paths into this KB. Saves a cold reader from having to understand the whole folder layout before they can find what they care about.

New engineer joining the project

You want to understand the architecture and what's been tried. Read in this order:

  1. CLAUDE.md — 2 min. What the KB is.
  2. Most recent file in synthesis/ for the product track you're joining — current architectural state.
  3. The product source tree itself (cite-outs from synthesis) — source of truth for implementation.
  4. experiments/ — concrete results: what was tried, what worked, what didn't.
  5. research-dispatches/ — open technical questions currently being chewed on.

Before contributing: CONVENTIONS.md.

Investor evaluating the company

You want to understand positioning, competitive landscape, and traction. Read in this order:

  1. STATE.md — 1 min. What is true right now, each line pointing at its source.
  2. comparisons/INDEX.md — competitive landscape entries (open the positioning file + any analyses of the best-funded competitors).
  3. Most recent file in synthesis/ — what the product actually is, where it stands.
  4. strategy/ — GTM, pricing, fundraising narrative as it crystallizes.
  5. traction/ — dated snapshots of pipeline, corpus, qualitative signals.

Advisor evaluating alignment

You want to understand whether the project is technically serious and how your expertise connects. Read in this order:

  1. advisors/<your-slug>/README.md — if it exists, alignment thinking is already drafted.
  2. Most recent file in synthesis/ — current system capabilities and gaps.
  3. research-dispatches/ — open technical questions where external expertise could help.
  4. experiments/ — what was tried, what broke, what was learned. Unvarnished.

Teammate joining the project

Different focus from "new engineer" — you may own product, go-to-market, or ops rather than core code.

  1. USER-MANUAL.md — 5 min. How to USE this KB.
  2. STATE.md — 1 min. What is true right now; ALIASES.md decodes the team's shorthand.
  3. team/INDEX.md — who's here.
  4. Most recent file in synthesis/ — product state.
  5. comparisons/INDEX.md — positioning + competitor reads.
  6. strategy/ — GTM / pricing / fundraising as it fills.
  7. discovery/ — customer conversations as they accumulate.
  8. advisors/ — who's being cultivated externally.

Before contributing: CONVENTIONS.md and AGENT-GUIDE.md.

LLM agent booting up

CLAUDE.md loads automatically and imports STATE.md (current truth) and ALIASES.md (shorthand → file); the rules in .claude/rules/ load with it. Answer from those plus the files the prompt hook lists. Before writing, read AGENT-GUIDE.md and the rulebook, CONVENTIONS.md. Don't guess rules.