Skip to content

Commit

Permalink
Merge branch 'main' into 389-bug-dates-are-in-american-format
Browse files Browse the repository at this point in the history
# Conflicts:
#	package.json
  • Loading branch information
jeff-horton-ho-sas committed Mar 15, 2024
2 parents e8bfd47 + 52e8648 commit 205322b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
13 changes: 8 additions & 5 deletions docs/standards/minimal-documentation-set-for-a-product.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: standard
order: 1
title: Minimal documentation set for a product
date: 2023-10-26
date: 2024-03-14
id: SEGAS-00003
tags:
- Documentation
Expand All @@ -18,7 +18,7 @@ A product should be documented to a minimum standard so that new engineers can b
- [Product documentation MUST include a description of the product and what it is for](#product-documentation-must-include-a-description-of-the-product-and-what-it-is-for)
- [Product documentation MUST include key architectural views](#product-documentation-must-include-key-architectural-views)
- [Product documentation MUST include a decision log](#product-documentation-must-include-a-decision-log)
- [Product documentation MUST include incident management information](#product-documentation-must-include-incident-management-information)
- [Product documentation MUST include runbooks for expected tasks](#product-documentation-must-include-runbooks-for-expected-tasks)
- [Product documentation MUST include information about observability](#product-documentation-must-include-information-about-observability)
- [Product documentation MUST include build, release and deployment processes](#product-documentation-must-include-build%2C-release-and-deployment-processes)

Expand All @@ -28,14 +28,15 @@ The description should provide domain context to an engineer and link to product

- Information about the team
- Key stakeholders
- Include contacts in case of a technical incident with the product
- Who the [Senior Responsible Owner (SRO)](https://www.gov.uk/government/publications/the-role-of-the-senior-responsible-owner/the-role-of-the-senior-responsible-owner) is
- User research findings
- Product roadmap
- Business analysis findings
- Governance and assurance documentation
- IT health check reports
- Security audits
- Service design package
- Service design package which MUST include the incident management process

### Product documentation MUST include key architectural views

Expand All @@ -45,9 +46,11 @@ The architectural views may contain architecture diagrams, security models, enti

A decision log should record key design decisions in context. A pattern should be selected to complement the team ways of working, and may include for example [Architecture Decision Records](https://adr.github.io/).

### Product documentation MUST include incident management information
### Product documentation MUST include runbooks for expected tasks

An incident management process should include technical points of contact, runbooks, and disaster recovery information.
Document any incident support, disaster recovery, and maintenance tasks that are the responsibility of the product team.

Where a task can't be automated, provide a runbook detailing how to carry out that task.

### Product documentation MUST include information about observability

Expand Down
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
},
"devDependencies": {
"axe-core": "^4.8.4",
"cypress": "^13.6.6",
"cypress-axe": "^1.5.0"
"cypress-axe": "^1.5.0",
"cypress": "^13.7.0"
}
}

0 comments on commit 205322b

Please sign in to comment.