Skip to content

Core HR Architecture & Release Documentation Index

Purpose: Central navigation for all project artefacts (backlog, quality, observability, operations). Use this as the single entry point for onboarding and refinement. Each section lists: Path, Status, Primary Consumers, Next Action.

1. Product & Scope

Artefact Path Status Audience Next Action
Master PRD (Full) 000-core-hr.prd.md Draft (not recently touched) PO, Arch Re-sync with release slice after refinement cycle
Release PRD Slice prd-core-hr-arch-release-estimation.md Current PO, Eng Leads Fill remaining open questions section
Story Template .github/story-template.md Baseline All Dev/PO Keep stable; evolve only via retro insights

2. Estimation & Planning

Artefact Path Status Audience Next Action
Release Estimation release-estimation-core-hr.md Current PO, PM Recalculate after Sprint 1 velocity observed
Sprint 1 Backlog SPRINT-1.md In Progress (Execution) Dev, QA Add burn-down metrics section mid-sprint

3. Epics Directory

Use EPICS.md for overview; individual epic files for deep dives.

Epic Code Name Path Status Next Action
CORE-USER User & Tenant Identity EPIC-CORE-USER.md Defined Groom stories for auth edge cases
HR-EMP Employee Core Profile EPIC-HR-EMP.md Defined Add data privacy NFR clarifications
CORE-BILLING Billing & Plans EPIC-CORE-BILLING.md Defined Flesh out proration & invoicing scenarios
CORE-ARCH Platform Architecture EPIC-CORE-ARCH.md Defined Add performance budgets section
DOC-MGMT Documents & Storage EPIC-DOC-MGMT.md Defined Define virus scanning acceptance criteria
HR-LEAVE Leave Management EPIC-HR-LEAVE.md Defined Add accrual edge cases
HR-RECRUIT Recruitment Funnel EPIC-HR-RECRUIT.md Defined Clarify candidate PII retention windows
HR-PERF Performance Reviews EPIC-HR-PERF.md Defined Detail calibration workflow
(Overview) Epics Index EPICS.md Current Link stories as added

4. Implemented Stories (Initial Set)

Story Path Points Domain Status
US-101 US-101.md 8 Identity Ready
US-102 US-102.md 5 Identity Ready
US-103 US-103.md 5 Identity Ready
US-301 US-301.md 5 Employee Ready
US-302 US-302.md 3 Employee Ready
US-311 US-311.md 8 Employee Ready
US-312 US-312.md 5 Employee Ready
US-321 US-321.md 8 Employee Ready
US-322 US-322.md 3 Employee Ready
US-331 US-331.md 5 Employee Ready

Placeholder Stories (Upcoming)

Story Path Domain Purpose
US-106 US-106.md Identity Introduce SSO federation
US-204 US-204.md Documents Secure upload & scanning
US-205 US-205.md Billing Subscription upgrade & proration
US-313 US-313.md Leave Cancellation lifecycle completion
US-332 US-332.md Performance Goal progress analytics event
US-401 US-401.md Observability/Data Event schema governance
US-402 US-402.md Observability Span coverage audit

Planned: Introduce Sprint 2 candidate stories after midpoint Sprint 1 review (add table here).

5. Quality Engineering

Artefact Path Purpose Next Action
Test Design Sprint 1 test-design-sprint-1.md Traceability and scenario coverage Populate real test IDs when implemented
Tenant Isolation Strategy tenant-isolation-test-strategy.md Assurance of strict isolation Add automated guardrail lint rules list

6. Observability & Analytics

Artefact Path Scope Next Action
Analytics Events Schema events-schema.md Event taxonomy & envelope Generate JSON Schema per event for CI validation
Logging & Tracing Guidelines logging-tracing-guidelines.md Structured logs + OTel spans Add sampling ratios after baseline metrics
Component ↔ Story Mapping component-story-mapping.md Architecture-story traceability Add after new stories; fill gaps (billing, docs)
Performance Budget performance-budget.md Latency/throughput/resource guardrails Link thresholds to alert rules & load tests
Event Schema Governance event-schema-governance.md Versioning & compatibility policy Integrate CI diff & changelog generation
Event JSON Schemas (v1 set) schemas/ Machine-readable contracts Add fixtures + CI validation pipeline

7. Operations

8. Performance & Capacity

Artefact Path Scope Next Action
Performance Budget performance-budget.md Latency & resource ceilings Align alert rules to matrix
Capacity & Scaling Strategy capacity-scaling-strategy.md Autoscaling, growth, RPO/RTO Add change log & perf test script refs

9. Cross-Cutting To Refine

Artefact Path Scope Next Action
Activation Runbook activation-runbook.md Funnel reliability & incident SOP Attach dashboard screenshot refs

8. Cross-Cutting To Refine

Open Questions Cluster (track & resolve): - PRD release slice open questions (see prd-core-hr-arch-release-estimation.md) - Billing proration specifics - Virus scanning SLA & retries - PII retention & anonymization policy (Recruit & Performance) - Performance budgets (CORE-ARCH) & load test targets

  1. AGENTS.md (roles & delivery standards)
  2. .github/story-template.md
  3. prd-core-hr-arch-release-estimation.md
  4. EPICS.md + targeted epic file
  5. release-estimation-core-hr.md
  6. SPRINT-1.md
  7. Stories under active sprint
  8. Quality (test design, isolation strategy)
  9. Observability (events, logging/tracing)
  10. Activation runbook

11. Upcoming Artefacts (Planned)

Artefact Rationale Owner Target Date
Fixtures & Sample Payloads Validate schemas with real examples Dev+QA Sprint 1 Mid
Hardening Checklist Security & perf readiness gate Arch Sprint 1 End
Sprint 2 Backlog Continuation planning PO Sprint 1 Review
Deployment Diagram Infra topology & scaling visibility Arch Sprint 2 Start

12. Change Log (Index Updates)

Date Change Author
2025-11-22 Initial index created AI Assistant
2025-11-22 Added placeholder stories + performance budget link AI Assistant
2025-11-22 Added event governance doc & initial v1 JSON Schemas AI Assistant
2025-11-22 Added capacity & scaling strategy + new section AI Assistant

Maintenance: Update this index whenever a new artefact is added or status changes. Keep sections terse; avoid duplicating story content.