Documentation Index¶
This directory contains the design, planning, and requirements artifacts for research_domain.
Core Documents¶
| File | Description |
|---|---|
requirements.md |
Functional and non-functional requirements. |
specifications.md |
Detailed behavior and domain specifications. |
sdd.md |
Software design description and architectural view. |
entities.md |
Current reference for the domain layer, including entities, relationships, enums, and repository contracts. |
implementation_plan.md |
Implementation roadmap and delivery breakdown. |
backlog.md |
Current project backlog. |
walkthrough.md |
Guided walkthrough of the project. |
constitution.md |
Guiding principles for the project. |
Domain-Specific Notes¶
| File | Description |
|---|---|
domain_model_advisorship.md |
Advisorship domain model notes. |
domain_model_advisorship_refactor.md |
Advisorship refactor history and rationale. |
Notes¶
- The package root README is the best place to start for installation, configuration, and quick usage examples.
- This folder focuses on project artifacts and design documents rather than step-by-step setup instructions.