For engineers and contributors. User-facing documentation lives at /docs.

PMFKit v1 Architecture

Documentation for production-ready v1: system architecture, agent contracts, evidence taxonomy, reasoning standards, and scope.

DocumentPurpose
agents-overview.mdWhat agents are; intern vs report agents; index to interns and report-agents
crawlers.mdIntern agents in technical detail (Discovery, Product, UI Capture, Competitor, pricing pass)
report-agents.mdReport agents in technical detail (CMO, BD, COO, CDO)
background-flow.mdEnd-to-end background flow (crawl → evidence → reports), entry points, step order, Evidence Layer in detail
system-architecture.mdHigh-level flow, Evidence Layer, orchestration, single entry, dependency map
agent-contracts.mdInput/output schemas per agent, versioning, shared artifact; no re-crawl/re-interpret
evidence-taxonomy.mdCategories (Product Surface, Documentation, Pricing, etc.), storage, tagging, traceability
reasoning-standards.mdEvidence → Inference → Judgment; claim types; no undocumented logic
pmf-stage-definition.mdOfficial PMF stages (0–5 / Idea Validation → Growth), mapping to DRL and UI
release-scope.mdWhat is in v1 and what is explicitly out
post-v1-roadmap.mdPhase 2–4 expansion (no implementation in v1)
output-narrative.mdCMO: recommendation templates, one thing this week, narrative alignment
diagnostic-examples.mdCMO: 5 real startup URLs and coherent-output criteria for release

Rule: If it’s not documented, it doesn’t exist.

Documentation maintenance and versioning

Before merging a release to main: Add or update the release report for that version (docs/vX.Y/release-report.md) with what shipped, then merge.

When you launch a new version and change behavior:

  1. Update the relevant architecture doc pages (e.g. new intern or report step → crawlers.md or report-agents.md).
  2. If I/O or contracts change, update agent-contracts.md and bump AGENT_CONTRACT_VERSION in core/agents/types.ts.
  3. Add an entry to the project changelog or release changelog (e.g. docs/v1.9/changelog.md).
  4. If entry points or pipeline order change, update background-flow.md.

Optional: add a "Last updated" or "Doc version" line at the top of changed docs for credibility and tracking.