This directory holds executable design and specification artifacts that accompany the PRD for development, integration, and operations.
本目录存放与 PRD（产品需求文档）配套的可执行设计与规范，供开发、集成与运维使用。
PRD Location: ../SPEC.md
| ID | Document | Purpose | Timing |
|---|---|---|---|
| 01 | Architecture and Tech Stack | Technology choices, high-level architecture, interfaces, data flow. | Start / Design Phase |
| 02 | API Specification | REST API Contract (OpenAPI 3.x). | Parallel with 01 |
| 03 | Assessment Report and Skill Contract | JSON Schemas for Reports and Skills. | Pre-Development |
| 04 | Integration Guide | AAD, ServiceNow configuration and mapping. | Integration Phase |
| 05 | Deployment Runbook | Deployment, config reference, ops. | Pre-Release |
Aligned with PRD:
- Language: Python 3.10+
- Web/API: FastAPI
- Agent: LangChain / LangGraph
- Vector DB: Chroma / Qdrant
- Parsing: PyMuPDF, python-docx, openpyxl
- LLM: LangChain Abstraction (OpenAI / Ollama)
See 01-architecture-and-tech-stack.md for details.
- Start with 01: Confirm stack and architecture.
- Sync 02: Use FastAPI to generate OpenAPI or write YAML first.
- Validate 03: Use
schemas/assessment-report.jsonfor validation. - Refine 04/05: Update when integrating with real environments.
docs/
├── README.md
├── 01-architecture-and-tech-stack.md
├── 02-api-specification.yaml
├── 03-assessment-report-and-skill-contract.md
├── 04-integration-guide.md
├── 05-deployment-runbook.md
└── schemas/
└── assessment-report.json