@ -191,27 +191,26 @@ Coding means to express ideas with the reduced vocabulary of a programming langu
### 1.5 Documentation as gardening
### 1.5 Documentation as gardening
- Code documentation require as much maintainance as code itself
When the docs does not reflect the behavior of the project, or when there are discrepancies between the two of them, the reliability of both code and documentation is undermined. Code documentation requires as much maintainance as code itself. Code transforms and documentation should follow.
documentation that does not reflect the behaviours of the code is a curse that undermine the code reliability. docs are not once in a lifetime effort, but a continuous commitment. code transforms and documentation should adapt.
There's a moltitude of ways in which changes in the codebase reflect on the documentation. New features ask for new sections. Breaking changes with previous versions require warnings and instructions on how to migrate towards the new one. Bugs and unexpected behaviours are to be addressed. Deprecated functions need to be trimmed out, or marked as outdated.
- Updates, corrections, additions, translations
On top of all the technical aspects, also the editorial work has to be taken into accounts. Adjustments and corrections and line-editing, clarification of convoluted paragraphs, rephrasing of confused sentences, highlighting of important passages. Certain projects also support internationalization, and the contents are translated and adapted to different languages' structures.
there are a moltitude of ways in which a change in the codebase reflects in the documentation. New feature asks for new sections. updates and breaking changes to with the previous versions require warnnings and instructions on how to migrate to the new one.
Writing docs is not a once in a lifetime effort, but rather a continuous commitment. It's a process with its own pace and timing, and similar to gardening is a form of care both for code and for the community around it.
bugs and unexpected behaviours of the code are to be pointed out. deprecated functions need to be trimmed.
on top of that all the editorial effort has to be considered. corrections and line editing. internationalization and localization.
It's a process that requires a massive amount of energy and resources. Yet, it seems to be constantly understimated, undervaluated, and pushed towards the margins. Something left for when there's nothing better to do, something to delegate. Something perceived as a burden, as a killjoy, a display of weakness from _real programmers_ that should be able to _use the source_.
- Massive amount of energy required
- Documentation as subaltern work (in open source projects)
a massive and constant amount of energy and time is required. resources put into documentation projects are not that much. documentation work is understimated and undervaluated.
```note
not super happy with the references for the part about gendered work, would prefer to have more recent accounts. could be something left open for a next episode?
```
```placeholder
documentation as gendered labour, and subaltern labour. examples: excerpt from pattern of software (all programmers are male, all technical writers are female), excerpt from life in code (tech conference public).
documentation as gendered labour, and subaltern labour. examples: excerpt from pattern of software (all programmers are male, all technical writers are female), excerpt from life in code (tech conference public).
```
[field work could be sooooo beneficial here like to search for contribution in docs repo]
- Post-meritocracy manifesto
all these effort are a confirmation of what proposed by the post meritocracy manifesto: the making of software is not just programming. the makers of software are not just engineers.
all these effort are a confirmation of what proposed by the post meritocracy manifesto: the making of software is not just programming. the makers of software are not just engineers.
@ -46,10 +46,10 @@ from reaching a public to creating a public
#### from the trans\*feminists servers manifesto to the queer motto api to the 360 degrees of proximity
#### from the trans\*feminists servers manifesto to the queer motto api to the 360 degrees of proximity
rethink participation in coding practice through a femminist perspective is not just swapping who can participate and who can not. doing so would just replicate current forms of exclusion.
rethink participation in coding practice through femminist perspectives is not just swapping who can participate and who can not. doing so would just replicate current forms of exclusion.
the trans\*femminist servers wishlist engage with a more messy entangled complex way of understanding participation and technology
the trans\*femminist servers wishlist engages with a more messy entangled complex way of understanding participation and technology
a way that open up for plurality, for instability, for safety, for situatedness
a way that open up for plurality, for questioning, for instability, for safety, for situatedness
1
1
@ -78,10 +78,13 @@ fluid processes - not purely technical architecture, but affective infrastructur
process of collective learning and knowledge transmission 360 degrees of proximities
process of collective learning and knowledge transmission 360 degrees of proximities
```note
```placeholder
would be nice to hear more about this new project from Mara - aka try send a mail tomorrow ?
questions for artemis and mika regarding sister server and 360 degrees of proximity
- is this a feminist approach to documentation? what do you see different from other kinds of documentation?
- how does it work? which methods and procedures are involved? who is the public and how does it influences the process? what's left after the install party? written docs? printed materials, recordings, other?
```
```
#### from alt-text as poetry to the discussion about accessibility in p5js to the soupboat
#### from alt-text as poetry to the discussion about accessibility in p5js to the soupboat
alt-text as poetry is a project by Bojana Coklyat and Shannon Finnegan
alt-text as poetry is a project by Bojana Coklyat and Shannon Finnegan