|
|
|
@ -1,5 +1,6 @@
|
|
|
|
|
- ![woodpicker that woodpicks](img/pic.jpg)
|
|
|
|
|
- **situated docs**
|
|
|
|
|
- it's a 2 words compound
|
|
|
|
|
- it's a 2 words title
|
|
|
|
|
- **docs** stands for documentation
|
|
|
|
|
- user manual
|
|
|
|
|
- instructions
|
|
|
|
@ -11,34 +12,67 @@
|
|
|
|
|
- how to be a developer™
|
|
|
|
|
- or how to do things with code without being a developer™
|
|
|
|
|
- that is actually the case for most of the people that enjoy coding
|
|
|
|
|
- or a way to enjoy it more
|
|
|
|
|
- **situated** refers to the context of this research
|
|
|
|
|
- or a way to enjoy coding more
|
|
|
|
|
- **situated** refers to the context of research
|
|
|
|
|
- which kind of software to look into
|
|
|
|
|
- _situated software_
|
|
|
|
|
- software built around the needs of a community
|
|
|
|
|
- that can be specific instead of generic
|
|
|
|
|
- that does not need to scale
|
|
|
|
|
- _example:_ xpub has a small server
|
|
|
|
|
- site specific software
|
|
|
|
|
- social specific software
|
|
|
|
|
- sss
|
|
|
|
|
- built around the needs of a community
|
|
|
|
|
- that can rely on the social infrastructure they come from
|
|
|
|
|
- specific instead of generic
|
|
|
|
|
- that don't need to scale
|
|
|
|
|
- that don't need to solve every problems
|
|
|
|
|
- our software
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![woodpicker hiding](img/hid.jpg)
|
|
|
|
|
- **example**
|
|
|
|
|
- xpub has a small server
|
|
|
|
|
- `server = machine connected to internet`
|
|
|
|
|
- we call it Soupboat
|
|
|
|
|
- _url_ `hub.xpub.nl/soupboat/`
|
|
|
|
|
- it is a shared space online
|
|
|
|
|
- where to prototype websites, hosting applications, etc
|
|
|
|
|
- we call it
|
|
|
|
|
- Soupboat
|
|
|
|
|
- _url_ `https://hub.xpub.nl/soupboat`
|
|
|
|
|
- a shared space online
|
|
|
|
|
- where to experiment
|
|
|
|
|
- publish websites
|
|
|
|
|
- host applications
|
|
|
|
|
- prototype tools
|
|
|
|
|
- etc
|
|
|
|
|
- a place to call home in the internet
|
|
|
|
|
- very public yet very intimate
|
|
|
|
|
- and now a series of _??_
|
|
|
|
|
- how to share knowledge about
|
|
|
|
|
- how to run
|
|
|
|
|
- how to manage
|
|
|
|
|
- how to configure
|
|
|
|
|
- our server
|
|
|
|
|
- _?_
|
|
|
|
|
- could this knowledge be useful for others than us
|
|
|
|
|
- could this small system support others similar ones
|
|
|
|
|
- how _situated knowledges_ inform the knowledge around our tools
|
|
|
|
|
- how different situations generate different documentations
|
|
|
|
|
- and how different contexts resonate together
|
|
|
|
|
- _??_
|
|
|
|
|
- **the plan** to think through these thing is to compile a list of resources
|
|
|
|
|
- how situated knowledges inform the knowledge around our tools
|
|
|
|
|
- how different situations generate different documentations
|
|
|
|
|
- how different contexts resonate together
|
|
|
|
|
- _???_
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![woodpicker that hides](img/hole.jpg)
|
|
|
|
|
- **the plan**
|
|
|
|
|
- these software are situated in specific contexts
|
|
|
|
|
- and contexts are different one from another
|
|
|
|
|
- there is not a _single_ _simple_ _smart_ solution™
|
|
|
|
|
- no one size fits all
|
|
|
|
|
- what is there though are some common features
|
|
|
|
|
- small scale and tempo
|
|
|
|
|
- a sociality around software
|
|
|
|
|
- an economy of different knowledges
|
|
|
|
|
- so the plan is research through these aspect
|
|
|
|
|
- and compile a list of resources
|
|
|
|
|
- to navigate this network of networks
|
|
|
|
|
- with the process of documentation
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
@ -46,10 +80,10 @@
|
|
|
|
|
- **a list**
|
|
|
|
|
- to explore the process of sharing knowledge and making worlds together around situated software
|
|
|
|
|
- compile a list of
|
|
|
|
|
- _references_
|
|
|
|
|
- _tools_
|
|
|
|
|
- _devices_
|
|
|
|
|
- _thoughts_
|
|
|
|
|
- _tools_
|
|
|
|
|
- _references_
|
|
|
|
|
- _excercises_
|
|
|
|
|
- _hints_
|
|
|
|
|
- _fieldwork_
|
|
|
|
@ -62,15 +96,19 @@
|
|
|
|
|
- a space to sketch contours
|
|
|
|
|
- and then draw out the borders
|
|
|
|
|
- a soft structure
|
|
|
|
|
- to connect different practices
|
|
|
|
|
- to respect the consistency of every items
|
|
|
|
|
- without worries of tangling them together
|
|
|
|
|
- a texture where to weave
|
|
|
|
|
- different voices
|
|
|
|
|
- different registers
|
|
|
|
|
- different genres
|
|
|
|
|
- list as writing machine
|
|
|
|
|
- different entry points
|
|
|
|
|
- a list as writing machine
|
|
|
|
|
- seems already fun
|
|
|
|
|
- **here some prompts:**
|
|
|
|
|
- ehe
|
|
|
|
|
- ahah
|
|
|
|
|
- **here some prompts to explore the list format**
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
@ -87,6 +125,7 @@
|
|
|
|
|
- because the source code is not just in 1 place
|
|
|
|
|
- but cloned in different machines
|
|
|
|
|
- care for the future life of the software
|
|
|
|
|
- and for the future users
|
|
|
|
|
- _care for what?_
|
|
|
|
|
- infrastructure
|
|
|
|
|
- accessibility
|
|
|
|
@ -98,8 +137,8 @@
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![a spiral](img/spiral.jpg)
|
|
|
|
|
- the making of software as a ꩜
|
|
|
|
|
- ![a pan](img/pan.jpg)
|
|
|
|
|
- **the making of software as a** ꩜
|
|
|
|
|
- source code is at the center of the ꩜
|
|
|
|
|
- with all the other actors ꩜ing around
|
|
|
|
|
- one can get into the making of software from a distance
|
|
|
|
@ -109,8 +148,12 @@
|
|
|
|
|
- distance from the center is related to specificity
|
|
|
|
|
- more distant
|
|
|
|
|
- less technical
|
|
|
|
|
- **documentation framework**
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![a crab](img/crab.jpg)
|
|
|
|
|
- _excercise:_ try to map a documentation framework on the ꩜
|
|
|
|
|
- ex: the diataxis
|
|
|
|
|
- swirling from the outside
|
|
|
|
|
- _tutorials_
|
|
|
|
|
- learning oriented
|
|
|
|
@ -147,9 +190,9 @@
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![Moon](img/moon.png)
|
|
|
|
|
- software and gravity
|
|
|
|
|
- **software and gravity**
|
|
|
|
|
- source code as a planet
|
|
|
|
|
- similar to the spiral
|
|
|
|
|
- similar to the ꩜
|
|
|
|
|
- gravitational approach
|
|
|
|
|
- satellites
|
|
|
|
|
- and orbits
|
|
|
|
@ -170,9 +213,8 @@
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![Lamp](img/light.jpg)
|
|
|
|
|
- if software illuminates an unknown, it does so through an unknowable
|
|
|
|
|
- wendy hui kyong chun
|
|
|
|
|
- software is a lamp
|
|
|
|
|
- **software is a lamp**
|
|
|
|
|
- if software illuminates an unknown, it does so through an unknowable, wendy h k chun
|
|
|
|
|
- documentation is the light
|
|
|
|
|
- you can see the lamp if the light is lit
|
|
|
|
|
- if it's not lit the lamp is there but you cannot see
|
|
|
|
@ -185,26 +227,26 @@
|
|
|
|
|
- you put near the bed
|
|
|
|
|
- there is no such a thing as undocumented software
|
|
|
|
|
- because without documentation you cannot see it
|
|
|
|
|
- as a piece of code would print
|
|
|
|
|
- as a piece of code would print to the stdout
|
|
|
|
|
- i am documented therefore i am
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![tanuki](img/tanuki.jpg)
|
|
|
|
|
- the spirit animal of the developer is the tanuki
|
|
|
|
|
- the **spirit animal** of the developer is the tanuki
|
|
|
|
|
- like racoons they collect resources from the internet
|
|
|
|
|
- they patch together snippets from
|
|
|
|
|
- stack overflow
|
|
|
|
|
- youtube comments of video tutorial
|
|
|
|
|
- youtube video tutorial
|
|
|
|
|
- git issues
|
|
|
|
|
- forum
|
|
|
|
|
- reddit
|
|
|
|
|
- thread on reddit
|
|
|
|
|
- code as an objet trouvé
|
|
|
|
|
- a dumpster diving approach to coding
|
|
|
|
|
- a matter of urgency
|
|
|
|
|
- a basic need
|
|
|
|
|
- seeing software happen
|
|
|
|
|
- holding code in your hands
|
|
|
|
|
- holding working code in your hands
|
|
|
|
|
- is more important
|
|
|
|
|
- than understanding it 100%
|
|
|
|
|
- there is always time
|
|
|
|
@ -212,16 +254,17 @@
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
- ![river](img/river.jpg)
|
|
|
|
|
- the list and the river
|
|
|
|
|
- the list and **the river**
|
|
|
|
|
- waters are shallow
|
|
|
|
|
- small text files are ok
|
|
|
|
|
- how to navigate a full thesis ?
|
|
|
|
|
- how to navigate a full thesis _?_
|
|
|
|
|
- swim
|
|
|
|
|
- what about deep waters
|
|
|
|
|
- wait
|
|
|
|
|
- friendly reminder that
|
|
|
|
|
- wet
|
|
|
|
|
- thesis and the project are two different things
|
|
|
|
|
- but go together
|
|
|
|
|
- _git_ writing workflow
|
|
|
|
|
- issues to annotate
|
|
|
|
|
|
|
|
|
@ -243,10 +286,11 @@
|
|
|
|
|
- because formatting with `CSS`
|
|
|
|
|
- is really handy
|
|
|
|
|
- sorcery
|
|
|
|
|
- conjuring the list
|
|
|
|
|
- the list can shuffle a lot
|
|
|
|
|
- without extra work
|
|
|
|
|
- find the machine on _git_
|
|
|
|
|
- _url_ `git.xpub.nl/kamo/writing-list`
|
|
|
|
|
- find it on _git_
|
|
|
|
|
- _url_ `https://git.xpub.nl/kamo/writing-list`
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
@ -256,6 +300,7 @@
|
|
|
|
|
- Situated Knowledges, Donna Harawai
|
|
|
|
|
- List and complexity: Annemarie Mol & John Law
|
|
|
|
|
- Diataxis Documentation Framework, Daniele Procida
|
|
|
|
|
- Software Studies Revisited, W H K Chun, W Soon, N Wardrip-Fruin, J Zhu
|
|
|
|
|
- Images from
|
|
|
|
|
- Sumiyaki Monogatari, Takeno Shigeyasu
|
|
|
|
|
- (Tales of a Charcoal Burner)
|
|
|
|
|