IntentGuard

S08.1 — Publish the recruiter-facing README

Planning / historicaltaskdelivery

Historical

Planning material. It summarizes and links to the authoritative specification and the current measured state — it does not replace either, and it is not current engineering truth.

Migration identity#

  • Canonical identifier: S08.1 (GitHub issue type: subtask).
  • Legacy identifier: C08.1 (retained as old_identifier).
  • Parent epic: E08.
  • Milestone: M1 — IntentGuard Weekend MVP.

Objective#

Explain the problem, architecture, measured comparison, confidence/abstention behavior, quick start, demo, repository map, and honest status concisely.

Rationale#

A reviewer needs a high-signal entry point that reflects real evidence and points to deeper authority.

Parent identifier#

E08.

Source task#

T-008.

Traceability#

Primary: T-008. Secondary: FR-010, NFR-010, AC-013, AC-014.

Prerequisites#

Final U03/U05/U06/U07 evidence and stable commands.

Likely files#

README.md, links to docs/OPERATIONS.md, docs/IMPLEMENTATION_STATUS.md, docs/LIMITATIONS.md, specification and reports.

Implementation boundary#

Concise landing page sourced from real outputs and authoritative documents; no complete specification copy.

MUST scope#

Objective, normalized lifecycle, architecture boundary, measured metrics, selective prediction, real demo, commands, status, limitations, license/data-model attribution.

Explicit non-goals#

Marketing exaggeration, optional roadmap detail, hand-maintained metric duplication, fake screenshots, or deployment guide.

Acceptance criteria#

A reviewer locates setup/demo/evidence/status within five minutes; commands are executable; metrics link to source reports; strict/degraded states are unmistakable.

Validation commands#

uv run python scripts/validate_foundation.py && make demo.

Expected evidence#

Valid links, command/output consistency, report-sourced metric presentation, and reviewer walkthrough notes.

Fallback and status consequence#

Unavailable evidence stays labelled unavailable; stale or unsupported claims make U08 Partial and strict MVP fails.

Stop condition#

Stop for metric drift, broken links, copied specification, mock demo, or contradictions with implementation status.

Definition of ready#

Final evidence paths and statuses are fixed.

Definition of done#

README is concise, accurate, reproducible, and consistent with the acceptance verdict.

Labels#

type:subtask, priority:MUST, area:documentation

Estimate#

0.5 hour.

Related in repository

Open in full graph →
DOCUMENTED_BY — source: docs/backlog/tasks/C08.1-recruiter-readme.md § S08.1 — Publish the recruiter-facing READMEREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.mdPART_OF — source: docs/backlog/TRACEABILITY.md § Source tasksPART_OF — source: docs/backlog/TRACEABILITY.md § Source tasksREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.md § TraceabilityREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.md § TraceabilityREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.md § TraceabilityREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.md § TraceabilityREFERENCES — source: docs/backlog/tasks/C08.1-recruiter-readme.md § TraceabilitySATISFIES — source: docs/specification/docs/TRACEABILITY.md § Functional traceabilityREFERENCES — source: docs/backlog/umbrellas/U08-documentation-delivery.md § TraceabilitySATISFIES — source: docs/specification/docs/TRACEABILITY.md § Functional traceabilitySATISFIES — source: docs/specification/docs/TRACEABILITY.md § Non-functional traceabilityREFERENCES — source: docs/backlog/umbrellas/U08-documentation-delivery.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U08-documentation-delivery.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U08-documentation-delivery.md § TraceabilityCURRENTdocument: S08.1 — Publish the recruiter-facing READMES08.1task: S08.1AC-013 — Local demonstra…acceptance-criterion: AC-013 — Local demonstrationAC-014 — Validation gateacceptance-criterion: AC-014 — Validation gateE08epic: E08FR-010 — Reproducible co…requirement: FR-010 — Reproducible commandsNFR-010 — Honest reportingrequirement: NFR-010 — Honest reportingT-008 — Honest recruiter…task: T-008 — Honest recruiter-ready delivery bundleU03 — TF-IDF logistic-re…capability: U03 — TF-IDF logistic-regression baselineU05 — Comparative evalua…capability: U05 — Comparative evaluation and selective prediction
Hover an edge for its provenance · click a node to open it10 nodes · 24 edges