Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Adoption Playbook

Week 1: Baseline & CI

  • Generate a baseline repo.sruja: sruja quickstart -r . --generate-baseline
  • Validate and refresh evidence: sruja lint repo.sruja then sruja sync -r .
  • Add sruja lint repo.sruja and sruja drift -r . -a repo.sruja to CI; fail on violations
  • Export docs: sruja export markdown repo.sruja

Week 2: Targets & Guardrails

  • Add slo and scale for critical paths.
  • Encode constraints and conventions; publish to teams.
  • Introduce views for API/Data/Auth focus.

Week 3: Governance & Evolution

  • Add policy pages for security/operability.
  • Document decisions with adr blocks; track evolution with slo values (target vs current).
  • Use Git for automatic change tracking (git log, git diff, version tags).
  • Wire linting to PR checks; require green builds.

CI Example (GitHub Actions)

name: sruja
on: [push, pull_request]
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Sruja CLI
        run: curl -fsSL https://sruja.ai/install.sh | bash
      - name: Lint baseline
        run: sruja lint repo.sruja
      - name: Drift check (declared vs actual)
        run: sruja drift -r . -a repo.sruja
      - name: Export Docs
        run: sruja export markdown repo.sruja

Success Metrics

  • Review cycle time ↓
  • Incident rate for architecture errors ↓
  • Consistency across services ↑

Note: Sruja is free and open source (Apache 2.0 licensed). Need help with implementation? Professional consulting services are available. Contact the team through GitHub Discussions to learn more.