UKHomeOffice / engineering-guidance-and-standards

Engineering Guidance and Standards for the Home Office
https://engineering.homeoffice.gov.uk
MIT License
14 stars 2 forks source link

A pattern for creating a engineering guidance and standards pattern document #354

Open jeff-horton-ho-sas opened 7 months ago

jeff-horton-ho-sas commented 7 months ago

What is the pattern you are suggesting? A meta-pattern for adding other patterns to the SEGAS site

What would be the benefit to the Home Office of following this pattern Keeps patterns on the site to a common format, reducing cognitive load, whilst not limiting what a pattern can express.

How do people implement this pattern Examples are the patterns already linked on this site.

Additional information There is a template file in the repo for new patterns that should be linked to Once created it should be added as a related link on the list of patterns

willhiorns commented 6 months ago

The link I'm providing here is from a different solution domain, but is to a book co-authored by "The Queen of Patterns", Linda Rising.

https://learning.oreilly.com/library/view/fearless-change-patterns/0201741571/ch02.html

If you read down the page a bit you'll find a little story about what happened when Linda tried to create a really stripped-down pattern format for a workshop... TL;DR, she ended up having to put all the usual fields back in because they turned out to be necessary for a working, minimal pattern description.

So "Name, Context, Forces, Problem, Solution, Rationale, and Resulting Context" seems like a best practice solution we could reuse with some confidence.

I'd be tempted to add "Experience Report", which wouldn't be provided up-front as part of the pattern, but can be used to gather feedback on how it works in our context.