Ragnarock
Documentation

Architecture documents

Generate Software Architecture Documents, High- and Low-Level Designs, and Architecture Decision Records from your SRS.

Ragnarock can generate full architecture documents from your completed SRS, saving you from writing them from scratch. The result is a complete Markdown document saved to your Documentation workspace.

Document types

TypeNameWhat it covers
SADSoftware Architecture DocumentEnd-to-end system overview — components, data flow, tech stack, deployment, and cross-cutting concerns.
HLDHigh-Level DesignModule breakdown, interface contracts between services, data models, and key design decisions.
LLDLow-Level DesignDetailed component design, class diagrams, API specs, database schema, and algorithms.
ADRArchitecture Decision RecordA single architectural decision — its context, the chosen option, rationale, and trade-offs.

Generate a document

You need a completed SRS first, since these documents are generated from it. There are two ways to start.

  1. Open Documentation and choose New document.
  2. Switch to Generate with Ragnarock.
  3. Pick the document type (SAD, HLD, LLD, or ADR).
  4. Optionally set a layer or service to scope the document — for example backend, frontend, or mobile. Leave it blank for a full-system document.
  5. Choose Generate document.

In Ragnarock, type one of /doc sad, /doc hld, /doc lld, or /doc adr. The document previews in the right-hand panel as it's generated. See Commands & actions.

What happens next

Generation runs in the background. When it finishes:

  • The document appears in your Documentation list with a Completed status.
  • If you started from Ragnarock, it also previews in the right-hand panel, where you can expand it full-screen.

You can then open it in the editor to refine it, change its status, or download it as Markdown or PDF.

Scoping by layer is handy for larger systems: generate a backend LLD and a frontend LLD separately rather than one sprawling document.

Generated documents are drafts built from your SRS. Review them for accuracy before treating them as final — and keep your SRS up to date so regenerated documents stay correct.

On this page