Skip to content

Commit cc7cc9a

Browse files
committed
More detail on README
1 parent cc7c91b commit cc7cc9a

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ In your new branch on your fork:
3232

3333
* Add a new use case directory to the root of this repository
3434
* Create an `index.md` file within
35-
* Ensure your document has a descriptive and concise title at the first line, in
36-
sentence case, e.g.:
35+
* Ensure your document has a descriptive and concise title (`h1` header) at the first
36+
line, in sentence case, e.g.:
3737

3838
```markdown
3939
# My use case title
4040
```
4141

42+
* Have two `h2` sub-headers: `## Current situation` (describe the problem) and
43+
`## Proposed improvement` (describe a potential solution).
44+
The "proposed improvement" header can have multiple options as `h3` headers, e.g.
45+
`### Option A`, `### Option B`, etc.
4246
* If you have any ancillary files, e.g. diagrams, screenshots, sketches, or animations,
4347
to go with your use case, include those in your new use case directory.
4448

0 commit comments

Comments
 (0)