Skip to content

Commit

Permalink
better blurb on README (#143)
Browse files Browse the repository at this point in the history
closes #24
  • Loading branch information
chrisns authored Jan 21, 2025
1 parent 7dc1c92 commit f4834a0
Showing 1 changed file with 65 additions and 1 deletion.
66 changes: 65 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The project is currently in an alpha phase, contributions are very welcome.

The intend of the maturity model tool and report is to provide targeted actionable guidance.

The questions are structured with (generally) 5 potential answers that are intended to range from the worst it could be, to the best it could be, with a distributed spread between that.
The questions are structured with 5 potential answers that are intended to range from the worst it could be, to the best it could be, with a distributed spread between that.

The answers are framed as attestations you should be able to make based on your current state, scoring 'low' is not necessarily a 'bad thing' in fact scoring too 'high' might in fact indicate over optimization and a disproportionate solution.

Expand All @@ -29,3 +29,67 @@ Its important to clarify what this is not, this is not intended to be a assuranc
The repository is configured with [dev containers](https://containers.dev/) so should be able to use [Github Codespaces](https://github.com/features/codespaces) or your preferred [compatible editor](https://containers.dev/supporting#editors).

You will find all the questions and guidance in [./src/assessment](./src/assessment/).
The format of these are in markdown in the following convention, _the details are capitalized for effect, but should be normal sentence case in actual use_.

You can add a new question simply by adding a new file, or modify existing ones as necessary.

To preview your changes, run `npm start` and then open [http://localhost:8080](http://localhost:8080) in your browser.

```markdown
---
title: QUESTION TITLE
tags: CATEGORY E.G. 'cost'
eleventyNavigation:
parent: CATEGORY E.G. 'cost'
---

### ANSWER:1

#### **How to determine if this good enough**

INSERT SOME TEXT HERE

#### **How to do better**

INSERT SOME TEXT HERE

### ANSWER:2

#### **How to determine if this good enough**

INSERT SOME TEXT HERE

#### **How to do better**

INSERT SOME TEXT HERE

### ANSWER:3

#### **How to determine if this good enough**

INSERT SOME TEXT HERE

#### **How to do better**

INSERT SOME TEXT HERE

### ANSWER:4

#### **How to determine if this good enough**

INSERT SOME TEXT HERE

#### **How to do better**

INSERT SOME TEXT HERE

### ANSWER:5

#### **How to determine if this good enough**

INSERT SOME TEXT HERE

#### **How to do better**

INSERT SOME TEXT HERE
```

0 comments on commit f4834a0

Please sign in to comment.