laa-architectural-diagrams's Introduction

[ARCHIVED] Legal Aid Agency Architecture Documentation

The documentation here uses the C4 model by Simon Brown. We use the FC4 toolset to normalise the source of C4 diagrams authored with Structurizr Express.

Archived status

As of 2021 this repository is no longer the source of truth. For the latest information you should look at the replacement repository, laa-architecture-as-code.

As a result of the above, this repository has been archived and marked as read only.

Editing

Install and setup the fc4 tool https://fundingcircle.github.io/fc4-framework/tool/#setup

The following helped in installing the java runtime required for this tool.

brew update
brew tap homebrew/cask-versions
brew tap adoptopenjdk/openjdk
brew cask install adoptopenjdk11-jre

Follow this workflow to make changes to the yaml files and to generate images

Requirements

Image files in this repository are tracked through Git Large File Storage. Please install it by following the site instructions.

Structure

Legal Aid Agency is divided into the following service areas, with their respective locations in the repository:

Service area	Location	Responsibility
Outside Legal Aid	`diagrams/outside/`	Diagrams that describe systems used by us but owned outside the Legal Aid Agency.
Get Access to Legal Aid	`diagrams/get-access/`	Providing members of the public with information about what is "legal aid" and how to apply for it. Contracting with legal advisors to provide legal aid for members of the public.
Get Legal Aid	`diagrams/get-legal-aid/`
Get Paid for Legal Aid	`diagrams/get-paid/`

Conventions

Colours

Legal Aid Agency software systems, people and elements use the "Ministry of Justice" websafe colour (#5a5c92).
Software systems, people and elements outside the UK Government use #28a197.

laa-architectural-diagrams's People

Contributors

Stargazers

Watchers

laa-architectural-diagrams's Issues

Two system context diagrams: operational and reporting?

Context

I am struggling to visually represent data flows for reporting purposes as usually it would complicate the diagrams too much.

Idea

What if we created two kinds of system context/landscape diagrams?

One for "operational" flows
One for "reporting" flows

Renaming this repository

We have the https://github.com/ministryofjustice/laa-architectural-decisions repository for decisions, and we have moved our ADRs there.

This repository now only contains diagrams.

What do you think about renaming it to reflect this purpose?

Decisions: https://github.com/ministryofjustice/laa-architectural-decisions

Diagrams:

-https://github.com/ministryofjustice/laa-architecture-documentation
+https://github.com/ministryofjustice/laa-architectural-diagrams

How to balance progress and outstanding questions?

I was wondering how to keep up the balance of getting something in the repository but not forgetting to action feedback.

It seems to me that feedback on these diagrams is usually quite big with multiple bullet points which personally I find awesome but also overwhelming. (#7, #6 have a few.)

I tried to create https://github.com/ministryofjustice/laa-architecture-documentation/projects/1 to reflect outstanding questions for the Getting access to Civil Legal Aid diagram. What do you think?

Recommend Projects

ministryofjustice / laa-architectural-diagrams Goto Github PK