Saltar a contenido

DocuGraph System Manifest & End-to-End Traceability Matrix

1. System Identification & Executive Summary

  • System Name: DocuGraph
  • System Type: AI-Assisted Atomic Documentation Editor & Dependency Graph System
  • Repository Layout (v0.01 activo): Monorepo (:docugraph-core, :docugraph-mcp) with deploy/, scripts/ and the MkDocs viewer.
  • Catálogo histórico: Las especificaciones FE-XX, BE-XX, OpenAPI y de base de datos se conservan para trazabilidad, pero no representan módulos implementados del perfil self-hosted.
  • Specification Methodology: Pure Atomic Documentation with YAML Frontmatter headers and zero cross-file content duplication.

Purpose & Scope

This central manifest serves as the authoritative inventory for the documentation specification artifacts across the DocuGraph monorepo lifecycle. It establishes traceability across the historical product catalog and the active self-hosted implementation: core graph logic, MCP resources/tools/prompts, Git operations, Oracle deployment and the read-only viewer.

2. Monorepo Document Inventory

The operational documentation architecture comprises 47 atomic Markdown nodes, including the three repository-root documents and the 44 nodes under docs/. The product-catalog inventory below retains its original 34-artifact phase breakdown for historical traceability.

Phase 0: Project Setup & Guidelines (2 files)

  • README.md (README): System Overview, Monorepo Architecture, and Quickstart Guide.
  • AGENTS.md (AGENTS): Guidelines for AI coding agents, mandatory rules, MCP tool definitions, and prompt templates.

Phase 1: Business Vision & User Stories (7 files)

Phase 2: Global Architecture & Domain Specifications (5 files)

Phase 2.5: Interaction Specifications (4 files)

Phase 3: Contract Specifications & Component Specs (13 files)

Phase 4: System Requirements, Implementation Plan & Test Strategy (3 files)

3. 100% END-TO-END TRACEABILITY MATRIX

The following matrix guarantees complete forward and backward traceability across all user stories, interaction flows, UI components, backend tasks, API operation IDs, database tables, MCP protocols, requirements, and test suites:

User Story ID Title Interaction Spec Frontend UI Component Backend Task Spec OpenAPI operationId Database Schema Tables MCP Tool / Resource / Prompt SRS IEEE 830 Req Tags Master Test Suite / Case ID
US-01 User Authentication & Session Management IX-01 FE-01 BE-01 loginUser table: users, table: subscriptions Auth session token context, mcp_api_keys auth SRS-SYS-001..003, SRS-SEC-001..003 TS-E2E-01, TS-BE-01, TS-FE-01
US-02 Project Creation & Repository Setup IX-02 FE-02 BE-02 createProject table: projects, table: users docugraph://workspace/nodes resource SRS-SYS-004..006, SRS-DES-002 TS-E2E-02, TS-BE-02, TS-FE-02
US-03 Interactive Dependency Graph Visualization IX-03 FE-03, FE-04 BE-03 buildGraph table: projects, table: nodes, table: node_edges get_dependency_graph tool, docugraph://workspace/graph resource SRS-SYS-007..009, SRS-PERF-001 TS-E2E-03, TS-BE-03, TS-FE-03
US-04 MCP Context Bundle Extraction for AI Tasks IX-04 FE-04 BE-04 getTaskContext table: nodes, table: node_edges, table: subscriptions get_task_context tool, prompt_implement_task prompt, docugraph://workspace/node/{id} resource SRS-SYS-010..012, SRS-PERF-002, SRS-SEC-004 TS-E2E-04, TS-BE-04, TS-MCP-01
US-05 Automated Graph Integrity & Traceability Validation IX-03 FE-03 BE-05 validateTraceability table: nodes, table: node_edges, table: projects validate_traceability tool, prompt_audit_traceability prompt, docugraph://workspace/audit-report resource SRS-SYS-013..015, SRS-PERF-003 TS-E2E-05, TS-BE-05, TS-CORE-02
US-06 Subscription Management & RevenueCat Pro Features IX-01, IX-02, IX-04 FE-05 BE-06 checkEntitlement table: subscriptions, table: users pro_tier Entitlement check in get_task_context depth limit SRS-SYS-016..018, SRS-QUAL-001 TS-E2E-06, TS-BE-06, TS-FE-05

4. MILESTONE EXECUTION & PHASE READINESS

Milestone ID Title Scope Summary Target Files Status
M1 Business Vision & Core Requirements Define product vision, revenue strategy, and 6 user stories 00_BUSINESS_VISION.md, US-01 .. US-06 APPROVED
M2 System Manifest, Domain & Interaction Specs System manifest, global spec, architecture, DB schema, glossary, 4 interaction specs 01_PROJECT_MANIFEST.md, 02_GLOBAL_SPEC.md, 03_ARCHITECTURE.md, 01_DATABASE_SCHEMA.md, 02_GLOSSARY.md, IX-01 .. IX-04 APPROVED
M3 REST OpenAPI, Backend & Frontend Component Specs REST API OpenAPI 3.1.0, 6 backend task specs, 5 frontend composable specs, MCP spec openapi.yaml, BE-01 .. BE-06, FE-01 .. FE-05, MCP_SPEC.md APPROVED
M4 SRS IEEE 830, Project Plan & Master Test Suite Formal SRS IEEE 830 specification, master project plan, master test plan, 34-file audit SRS_IEEE-830.md, PLAN-01_delivery-plan.md, TEST-01_verification-plan.md APPROVED

Nota (DEC-001): los hitos M1–M4 describen la autoría del catálogo documental. La secuencia de entrega vigente es la de §5 de MASTER-00: Gate 0 → PoC → MVP Shipaton → Producto, y ninguna fase se implementa sin aprobar su gate (§15).

4.5 CLASIFICACIÓN POR FASES (MASTER-00 v0.6)

Clasificación de cada artefacto del catálogo según el campo phase de su frontmatter, alineada con MASTER-00 (§0.2, §5, §6).

Fase Artefactos
GATE_0 MCP-SPEC (subconjunto: get_task_context + validate_traceability, STDIO)
POC US-04, US-05, IX-04, BE-04, BE-05
MVP US-06, FE-02, FE-03, FE-04, FE-05
POST_MVP US-01, US-02, US-03, IX-01, IX-02, IX-03, BE-01, BE-02, BE-03, BE-06, FE-01, UI-MAP-00, GLOBAL-02, ARCH-03, SCHEMA-01, SRS-830, PLAN-01, TEST-01, API-OPENAPI
Gobernanza / Transversal MASTER-00, README, AGENTS, MANIFEST-01, GLOSSARY-01, RES-00…RES-03, EXP-01, DEC-LOG

Los documentos POST_MVP forman parte del catálogo de producto sujeto a validación: no constituyen alcance aprobado de Gate 0 / PoC / MVP.

5. TRACEABILITY VERIFICATION RULES

To maintain absolute system integrity, the automated audit tool (validate_traceability) enforces the following validation checks across the workspace:

  1. Frontmatter Integrity: Every file must contain valid YAML frontmatter delimiters (---) and mandatory top-level keys (id, title, type, status, tags, links).
  2. Zero Orphan Nodes: Every document ID declared in frontmatter MUST appear in at least one upstream depends_on or downstream depended_by list of another artifact, except root nodes (README).
  3. OpenAPI Operation Linkage: Every operationId cited in backend or interaction specs MUST exist in docs/api/openapi.yaml.
  4. Database Table Linkage: Every table: XXX link MUST reference a valid table name defined in docs/domain/01_DATABASE_SCHEMA.md.
  5. No Content Duplication: Code snippets, API contracts, or DDL statements must exist ONLY in their authoritative primary documents (openapi.yaml, 01_DATABASE_SCHEMA.md).

6. TRACEABILITY INDEX