Skip to content

Commit 5171380

Browse files
authored
Create a quickstartmd page (#251)
1 parent b617a16 commit 5171380

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Software Engineering Quality Framework
22

3+
## How to get started
4+
5+
See the [Quick Start Guide](quickstart.md)
6+
37
## Purpose
48

59
This framework is concerned with using "good" software engineering to support rapid and safe delivery of high-quality software, at scale

quickstart.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Quickstart
2+
3+
This page will guide you through how to adopt the Engineering Quality Framework within your team.
4+
5+
## Overview
6+
7+
Read the [introduction](README.md) to the Engineering Framework.
8+
9+
## Dashboard
10+
11+
Complete an [engineering dashboard](insights/metrics.md).
12+
This will quickly assess the engineering maturity of your team in specific areas.
13+
14+
## Review
15+
16+
Complete a [quality review](insights/review.md).
17+
This is a team-led self assessment to discover areas of improvement: a "technical retro".
18+
19+
## Use existing solutions
20+
21+
Browse the [tools section](tools).
22+
This contains cloneable scripts, docker files, and pipeline steps that can be added straight to your existing systems.
23+
24+
## Embed best practices within your team
25+
26+
The entire team should familiarise themselves with the Framework's [Principles](principles.md).
27+
And with the common [Patterns](patterns) that help achieve those Principles.
28+
29+
Specialists should familiarise themselves with [best Practices](practices) in their areas.
30+
31+
Run a quality review every 3 months to keep track of progress.
32+
33+
Update dashboards monthly.
34+
35+
## Join the community
36+
37+
Create branches and submit Pull Requests to add your own content, or improve existing pages.
38+
39+
[Raise an Issue](https://github.com/NHSDigital/software-engineering-quality-framework/issues/new) for things you would like us to add or amend.
40+
41+
Join the [Communities of Practice](communities/communities-of-practice.md) that jointly input into the Framework.
42+
43+
Join weekly knowledge-sharing meetings, focused on building shared solutions.
44+
45+
Ask for a Technical Coach to help guide your team. You can also offer yourself up as a coach to help other teams.

0 commit comments

Comments
 (0)