code blocks

main
km0 2 years ago
parent a3c2daa8f1
commit 797c1f4b1e

@ -1,10 +1,9 @@
## Coding contingencies ## Coding contingencies
```note ```todo
TODO: - how to quote propperly an introduction from a book series? (software studies)
- how to quote propperly an introduction from a book series? (software studies) - find where to put code documentation & developers paragraphs
- find where to put code documentation & developers paragraphs - elaborate on citations
- elaborate on citations
``` ```

@ -1,6 +1,6 @@
## Who is reading ## Who is reading
``` ```note
documentation as a publishing surface? documentation as a publishing surface?
yes because yes because
@ -13,7 +13,9 @@ yes but
``` ```
### Getting started ### Getting started
`("Getting startled" could also make for a nice title)` ```note
("Getting startled" could also make for a nice title)
```
Reading undocumented code feels like being an ant walking on a big painting. You can see the strokes of a brush and have an intuition of their direction, but what's missing is an overall idea of how the composition flows. Documentation provides guidance through the bunch of functions and statements that makes software, a bird's eye perspective. It is often the first thing one gets across when approaching a new library or programming language, and it shapes the way a developer thinks about particular piece of code. Reading undocumented code feels like being an ant walking on a big painting. You can see the strokes of a brush and have an intuition of their direction, but what's missing is an overall idea of how the composition flows. Documentation provides guidance through the bunch of functions and statements that makes software, a bird's eye perspective. It is often the first thing one gets across when approaching a new library or programming language, and it shapes the way a developer thinks about particular piece of code.
@ -63,7 +65,7 @@ Programming means to deal with picky stubborn machines that don't overlook a sin
Instead... Instead...
``` ```note
lowering barriers lowering barriers
- debugging (p5.js education working group, 2015) - debugging (p5.js education working group, 2015)
- aesthetic programming - aesthetic programming
@ -71,7 +73,7 @@ lowering barriers
``` ```
## "Natural" reader ## "Natural" reader
``` ```note
- assuming a certain kind of reader - expert - dude - assuming a certain kind of reader - expert - dude
- references: - references:
- programming for the millions (ullman, 2016) - programming for the millions (ullman, 2016)

Loading…
Cancel
Save