table of content

main
km0 2 years ago
parent d5a439498c
commit bff0cf0d80

@ -38,33 +38,66 @@ The critical and theoretical research will be weaved around the actual documenta
0. **Coding Contingencies** 0. **Coding Contingencies**
Situate software as cultural object and proposes documentation as a surface to explore it. Situate software as cultural object and proposes documentation as a surface to explore it.
- Context around software, software studies - Context around software
- refer to software studies
- Define software documentation - Define software documentation
- reference, how-to, guide, tutorial - reference, how-to, guide, tutorial
- here we are not focusing on one specific format, bur rather to a form of care (for users, for software, for context) - here we are not focusing on one specific catch-all format
- rather to a form of care (for users, for software, for context)
- Introduce issues around software and documentation [probably articulated better later on] - in the context of situated software
- Propose documentation as a way to address these issues [probably articulated better later on]
Question: mention the context of situated software here ?? - Introduce issues around software and documentation [chapters overview]
- Propose documentation as a way to address these issues [articulated better at the end]
1. **Participation** 1. **Participation**
Who gets to write, and who is forced to do it? How does development and technical writing interact? Is the technical writer a subaltern position in the industry of software development? What about users? 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
- Historical overview of how software documentation changed (from printed technical manual to wiki and discord server) - (from printed technical manual to wiki and discord server)
- Printed manuals - from highly centralized manuals to open and collaborative documents
- Manpages
- Websites - Actors involved and hierarchies (from developers to end-users, gendered work, subaltern work)
- Wikis
- Online communities - Is writing documentation subaltern work?
- Reflection on actors involved and hierarchy (from developers to end-users, gendered work, subaltern work, post-meritocratic manifesto) - No one wants to write documentation, or pay someone to do it
- Historical accounts of who writes?? (Outside of time, Ullman) (Into the ground C++, Gabriel)
- 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** 2. **Destination**
Who can read documentation? Who can access? Where is the documentation hosted? How does it relate with a bigger context, if any? How does it produce public?
Who is this documentation for?
How does it relate with a bigger context?
Who can access it?
Where is the documentation hosted?
- Assuming a certain kind of reader (often male, often white, often with formal education)
- Read the feminist manual (Karayanni, 2021)
- Programming for the millions (Ullman, 2016)
- situated software require situated documentation [case studies]
- Wheatering software winter, about the impossibility to print out documentation, tshirt docs (100R, 2022)
- Accessible documentation
- Welcoming documentations
3. **Tone and style** 3. **Tone and style**
How to make a documentation more accessible? How to create multiple entry points in a complex topic? How to address different kind of users, and not just a generic one? How to orientate software in the world?
How to make documentation more accessible?
How to create multiple entry points in a complex topic?
How to address different kind of users, and not just a generic one?
How to orientate software in the world?
- Documentation as an interface between different knowledges
4. **Susteinability** 4. **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. 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.

Loading…
Cancel
Save