Features
Documentation workspace
Create and manage BRD, PRD, SRS, and architecture documents.
Project documentation lives at /dashboard/projects/{projectId}/documentation. Each record is typed markdown with metadata (status, type, reviewers).
Document types
The DocumentationType enum defines supported kinds:
| Type | Common name |
|---|---|
brd | Business Requirements Document |
prd | Product Requirements Document |
frd | Functional Requirements Document |
srs | Software Requirements Specification |
srd | Software Requirements Document |
sad | Solution Architecture Document |
hld | High-Level Design |
lld | Low-Level Design |
adr | Architecture Decision Record |
api | API specification |
icd | Interface Control Document |
dbd | Database Design |
stp / std | Test plan / description |
rtm | Requirements traceability matrix |
ug | User guide |
om | Operations manual |
wbs | Work breakdown structure |
raci | RACI matrix |
note | General note |
Pick the type that matches your delivery phase — SRS/PRD during discovery, HLD/LLD during build.
Create and edit
Open Documentation → Create → choose type and title.
Edit in the markdown workspace at .../documentation/{documentationId}.
Set status (draft, pending_review, completed, rejected) when your process requires
sign-off.
Use AI-assisted edit flows (sheet/dialog) to expand sections from prompts.
API
| Method | Path | Purpose |
|---|---|---|
GET | /projects/:projectId/documentations | List |
POST | /projects/:projectId/documentations | Create |
GET | /projects/:projectId/documentations/:id | Read |
PATCH | /projects/:projectId/documentations/:id | Update |
DELETE | /projects/:projectId/documentations/:id | Delete |
AI-generated documents
| Trigger | API | Output |
|---|---|---|
| Requirements chat | POST .../ai/requirements | Refined SRS in draft/session |
| Architecture doc | POST .../ai/arch-doc/generate | SAD/HLD-style content |
| Planner | POST .../ai/plan/generate | Tasks (not a doc record) |
Always review AI output before marking completed.
Practices
- One authoritative SRS per project — use
GET /projects/:projectId/ai/draftas the shared baseline for new AI sessions. - Link requirements IDs in test cases and tasks for traceability.
- Export or copy markdown for external review; version control can mirror
contentvia your own process.
See also Ragnarock AI and Tasks.