Skip to content

Commit 0e7acf4

Browse files
authored
Add quality reference links to README (#50)
2 parents 989cdfe + 51ecf9d commit 0e7acf4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,15 @@ pre-commit install
1818
```
1919

2020
You only need to do this once!
21+
22+
23+
### Writing: quality, voice, style, formatting, andragogy, ?
24+
25+
Reference [diataxis](https://diataxis.fr/) for quality guidance.
26+
27+
Understand your audience. Which of the
28+
[four kinds of documentation](https://diataxis.fr/start-here/#the-four-kinds-of-documentation)
29+
are you writing?
30+
31+
* [Learning-oriented tutorial](https://diataxis.fr/tutorials/)
32+
* [Understanding-oriented explanation](https://diataxis.fr/explanation/)

0 commit comments

Comments
 (0)