Skip to content

Commit 34fa9cc

Browse files
committed
The Illusion of Easy Documentation
1 parent 421db46 commit 34fa9cc

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ arbitrarily. Please don't expect it to be polished.
114114
- [Provide Drivers Alongside Your Hardware](#provide-drivers-alongside-your-hardware)
115115
- [Provide Simulators Alongside Your Hardware](#provide-simulators-alongside-your-hardware)
116116
- [Documentation](#documentation)
117+
- [The Illusion of Easy Documentation](#the-illusion-of-easy-documentation)
117118
- [Less prose, more structure](#less-prose-more-structure)
118119
- [Too Much Structure Overload](#too-much-structure-overload)
119120
- [Encyclopedic Document](#encyclopedic-document)
@@ -1257,8 +1258,10 @@ great option, as these languages integrate well with embedded environments.
12571258

12581259
## Documentation
12591260

1260-
- Good documentation is dry and boring. This can create an illusion that writing
1261-
good documentation is easy when in fact it is not.
1261+
### The Illusion of Easy Documentation
1262+
1263+
Good documentation is dry and boring. This can create an illusion that writing
1264+
good documentation is easy when in fact it is not.
12621265

12631266
### Less prose, more structure
12641267

0 commit comments

Comments
 (0)