Documentation Workflow

Technical architecture documentation frequently falls out of sync with production code. Rekhic bridges this gap by enabling an agile, repeatable documentation loop.

The Living Architecture Loop

text Copy
       1. Code Repository
  (Commits, PRs, New Services)
               │
               ▼
   2. Import into Rekhic
(README, Code, or Public GitHub)
               │
               ▼
   3. Refine on the Canvas
 (Update boundaries, clarify flows)
               │
               ▼
 4. Export Markdown & Images
 (Commit ARCHITECTURE.md + PNG/SVG)
               │
               ▼
   5. Living Git Documentation

Recommended Team Practices

1. Commit ARCHITECTURE.md to Your Repo: Maintain an architectural overview at the root of your project repository alongside README.md.
2. Review Diagrams in Pull Requests: When introducing a new service or changing a database relationship, export the updated diagram and include both the image and the generated markdown diff in the PR description.
3. Keep ADRs Structured: When writing an Architecture Decision Record (e.g. ADR-004: Migrating from REST to gRPC), use Rekhic to model the before and after states and export markdown for both.

Next: Explore pre-configured blueprints in Using Templates.