Skip to content

Specification Cross-Reference Table#

Last Updated: 2025-11-09

This table tracks relationships between requirements, specifications, source code, tests, and diagrams. It serves as the central navigation hub for understanding how requirements are implemented throughout the codebase.

Purpose#

  • Traceability: Follow a requirement from concept through implementation
  • Coverage: Ensure all requirements have specifications and implementations
  • Testing: Verify all specifications have corresponding tests
  • Documentation: Link specifications to relevant diagrams and documentation

How to Use This Table#

  • Links are bidirectional: Each linked file should reference back to this table
  • Status values: Not Started, In Progress, In Review, Approved, Implemented, Tested
  • Multiple entries: Separate multiple files with <br> in the table cell

Cross-Reference Table#

Requirement Specification Source Files Test Files Diagrams Status
Example: example-req example-spec src/example.py test/test_example.py architecture-example.md
threat-model-example.md		 Example
REQ-000a_General (General) TBD N/A N/A context-main
context-community		 IN PROGRESS
REQ-000b_Scope (Scope) TBD N/A N/A TBD IN PROGRESS
REQ-000c_UseCases (Use Cases) TBD N/A N/A Multiple - see MD IN PROGRESS
REQ-000d_UCBDs (Use Case Behavior Diagrams) TBD N/A N/A Multiple - see MD IN PROGRESS
REQ-000e_Requirements (Requirements Specs) Multiple TBD TBD Multiple in UCBDs IN PROGRESS

Adding New Entries#

When creating new requirements or specifications:

  1. Add a new row to the table
  2. Link to the requirement document in requirements/
  3. Link to the specification document in specifications/
  4. As implementation progresses, add links to source files, tests, and diagrams
  5. Update the status column
  6. Update the "Last Updated" date at the top of this file

Automation#

This table can be automatically updated using: - GitHub Actions (see .github/workflows/) - Pre-commit hooks - Manual update scripts

See .github/instructions/automation-setup.instructions.md for details.

Header Template for Linked Files#

Each file referenced in this table should include a header section linking back:

---
**Cross-Reference**: See [SPEC-CROSS-REFERENCE.md](../SPEC-CROSS-REFERENCE.md) for implementation tracking
**Requirement**: [REQ-XXX](../requirements/req_xxx.md)
**Specification**: [SPEC-XXX](../specifications/spec_xxx.md)
---

Adjust paths as needed based on file location.