kamo
/
thesis
1
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '58946adb98'
${ noResults }
thesis/chapters/01_lowering_barriers.md

1.7 KiB
Raw Blame History

Who is reading?

  • software documentation

    • which software (code related, situated software)
    • which documentation (from framework to form of care)
    • references:
      • diataxis (procida, 2017)
      • situated software (shirky, 2004)

Documentation comes in many different forms. Daniele Procida offers a systematic approach to organize this wealth of formats (diataxis.fr, 2017). His framework is built at the intersection of two axis: one goes from theoretical to practical knowledges, while the other from study to work. Here study could be read as learning or understanding, while working means getting things done. Another powerful couple of synonims is receiving and giving: by combining the renamed axis we can get a glimpse of the flow of knoweldge involved in documentation.

practice receiving tutorial
theory receiving explanation
practice giving how to
theory giving reference

The structure of dyataxis is useful to navigate through the different needs of a reader, or through different readers at all. So who's reading?

  • who's reading?

    • assuming a certain kind of reader

      • expert
      • dude

    • references:

      • programming for the millions (ullman, 2016)
      • read the feminist manual (karayanni, 2021 )

  • lowering barriers

    • Problems with depth (too shallow or too deep)
    • Where to start?
    • references:
      • welcome.js (bridle, 2016)
      • debugging (p5.js education working group, 2015)

  • multiple entry points

    • different entries make for different knowledges
    • drawings and memes