@ -13,7 +13,7 @@ These contingencies are situated in precise economical, cultural, creative, poli
How to offer a point of view through the lens of software?
Who get to participate in this process of making meaning?
How to create a discourse for the code to inhabit?
How to stretch the affordances of code, besides, technicality, marketing, and advertisement?
How to stretch the affordances of code, besides technicality, marketing, and advertisement?
## Enter documentation
@ -22,7 +22,7 @@ Could software documentation:
0. be a mean to explore these contingencies?
1. be an ideal surface to build worlds?
2. be an interface between different knowledges?
3. be a device to trigger different kind of economy around situated software?
3. be a device to trigger different kinds of economy around situated software?
How can situated practices inform the process of documenting software?
And how can situated software inform the process of technical writing?
@ -51,11 +51,11 @@ The critical and theoretical research will be weaved around the actual documenta
- Introduce issues around software and documentation [chapters overview]
- Propose documentation as a way to address these issues [articulated better at the end]
1. **Participation**
How does development and technical writing interact?
Who gets to write, and who is forced to?
Is the technical writer a subaltern position in the industry of software development?
Involvement of end-users?
1. **Participation**
How does development and technical writing interact?
Who gets to write, and who is forced to?
Is the technical writer a subaltern position in the industry of software development?
Involvement of end-users?
- Historical overview of how software documentation format changed
@ -70,7 +70,7 @@ The critical and theoretical research will be weaved around the actual documenta
- The post-meritocracy manifesto (Ehmke, 2018)
"We acknowledge the value of all contributors as equal to the value of contributors who are engineers."
2. **Destination**
1. **Destination**
How does it produce public?
Who is this documentation for?
How does it relate with a bigger context?
@ -88,7 +88,7 @@ The critical and theoretical research will be weaved around the actual documenta
- Accessible documentation
- Welcoming documentations
3. **Tone and style**
2. **Tone and style**
How to make documentation more accessible?
How to create multiple entry points in a complex topic?
@ -97,53 +97,59 @@ The critical and theoretical research will be weaved around the actual documenta
- Documentation as an interface between different knowledges
4. **Susteinability**
3. **Susteinability**
How to face the lack of resources when approaching technical writing?
Strategies to share workloads and collaboration
Strategies to take care of shared piece of software.
## TOC bis + math
1. Coding Contingencies _(2000)_
Situate software as cultural object and proposes documentation as a surface to explore its issues.
1. Coding Contingencies _(2000)_
Situate software as cultural object and propose documentation as a surface to explore it.
1. Context around software, besides technicality
2. Introduce issues around software and documentation
1. Context around software, besides technicality _(500)_
2. Introduce issues around software _(1000)_
1. Biased and hostile environments
2. Evergrowing complexity and black box
- Toxic masculinity, encoded chauvinism, western monoculture
2. Evergrowing complexity
- Intimidating learning curve, disproportion of means, mistification
3. The universal solution™
- Techno solutionism, gray tech, ideology
3. Propose documentation as a way to address these issues
1. Welcoming readers
3. Propose documentation as a way to address these issues _(500)_
1. Welcoming diverse knowledges
2. Lowering barriers and create entry points
3. Multiple strategies to tackle on problems
3. Orientate software in the world
2. Documentation as an interface _(3000)_
Aknowledge documentation as a meeting point for different knowledges, as vantage point from where to question software culture.
2. Documentation as an interface _(3000)_
Aknowledge documentation as crossroad for different actors, as intersection between code, machines, developers, users. Articulate it as a vantage point from where to reason about software.
0. Define software documentation
1. Small historical overview: from printed manuals to discord servers
