index almost ok (still wip)

main
km0 2 years ago
parent c534962339
commit 834886b040

@ -31,11 +31,12 @@ And how can situated software inform the process of technical writing?
![exploratory documentation aspects + 2 frogmouth birds](img/frogmouth_aspects.jpg) ![exploratory documentation aspects + 2 frogmouth birds](img/frogmouth_aspects.jpg)
<!--
The thesis is composed of different texts: some provide context and critical background to situate the research, while others consist in experiments of actual documentation written for software developed within our course. Every piece of documentation will try to reflect on different angles. The thesis is composed of different texts: some provide context and critical background to situate the research, while others consist in experiments of actual documentation written for software developed within our course. Every piece of documentation will try to reflect on different angles.
The critical and theoretical research will be weaved around the actual documentations, in order to create a discourse and annotate the development of this practice. The critical and theoretical research will be weaved around the actual documentations, in order to create a discourse and annotate the development of this practice.
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 - Context around software
@ -51,7 +52,7 @@ The critical and theoretical research will be weaved around the actual documenta
- Introduce issues around software and documentation [chapters overview] - Introduce issues around software and documentation [chapters overview]
- Propose documentation as a way to address these issues [articulated better at the end] - Propose documentation as a way to address these issues [articulated better at the end]
1. **Participation** 1. **Participation**
How does development and technical writing interact? How does development and technical writing interact?
Who gets to write, and who is forced to? Who gets to write, and who is forced to?
Is the technical writer a subaltern position in the industry of software development? Is the technical writer a subaltern position in the industry of software development?
@ -84,25 +85,22 @@ The critical and theoretical research will be weaved around the actual documenta
- Programming for the millions (Ullman, 2016) - Programming for the millions (Ullman, 2016)
- situated software require situated documentation [case studies] - situated software require situated documentation [case studies]
- Wheatering software winter, about the impossibility to print out documentation, tshirt docs (100R, 2022)
- Accessible documentation - Accessible documentation
- Welcoming documentations - Welcoming documentations
2. **Tone and style** 2. **Tone and style**
How to make documentation more accessible? How to make documentation more accessible?
How to create multiple entry points in a complex topic? 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 address different kind of users, and not just a generic one?
How to orientate software in the world? How to orientate software in the world?
- Documentation as an interface between different knowledges - Documentation as an interface between different knowledges
3. **Susteinability** 3. **Susteinability**
How to face the lack of resources when approaching technical writing? How to face the lack of resources when approaching technical writing?
Strategies to share workloads and collaboration Strategies to share workloads and collaboration
Strategies to take care of shared piece of software. Strategies to take care of shared piece of software. -->
## TOC bis + math
1. Coding Contingencies _(2000)_ 1. Coding Contingencies _(2000)_
Situate software as cultural object and propose documentation as a surface to explore it. Situate software as cultural object and propose documentation as a surface to explore it.
@ -117,7 +115,7 @@ The critical and theoretical research will be weaved around the actual documenta
3. The universal solution™ 3. The universal solution™
- Techno solutionism, gray tech, ideology - Techno solutionism, gray tech, ideology
3. Propose documentation as a way to address these issues _(500)_ 3. Propose documentation as a surface to address these issues _(500)_
1. Welcoming diverse knowledges 1. Welcoming diverse knowledges
2. Lowering barriers and create entry points 2. Lowering barriers and create entry points
3. Orientate software in the world 3. Orientate software in the world
@ -127,29 +125,47 @@ The critical and theoretical research will be weaved around the actual documenta
0. Define software documentation 0. Define software documentation
1. Small historical overview: from printed manuals to discord servers 1. From printed manuals to discord servers _(small historical overview)_
2. Dyataxis framework: Reference, How-to, Guide, Tutorial 2. Dyataxis framework: Reference, How-to, Guide, Tutorial.
1. Welcoming diverse knowledges 1. Welcoming diverse knowledges
- Who is writing? - _Who is writing?_
- Who will read? - Documentation as subaltern work?
- Documentation as a form of care
- Programming for the millions (Ullman, 2016) - _Who will read?_
- Read the feminist manual (Karayanni, 2021) - Read the feminist manual (Karayanni, 2021)
- Programming for the millions (Ullman, 2016)
- Who is making of software?
- A crowd besides developers
- Post-meritocracy manifesto (Ehmke, 2018)
2. Lowering barriers and create entry points 2. Lowering barriers and create entry points
- Paths through complexity - _Who is addressed?_
- Demistifying - [welcome.js](https://jamesbridle.com/works/welcome-js) (Bridle, 2016)
- Bridle Welcome to console
- Debugging (P5js Education Working Group, 2015) - Debugging (P5js Education Working Group, 2015)
- _Who can access?_
- Wheatering software winter (100R, 2022)
3. Orientate software in the world 3. Orientate software in the world
3. Situated software requires Situated documentation (3000) - _Who is making the software?_
- Post-meritocracy manifesto (Ehmke, 2018)
- _How are we making it?_
- Patterns of Software (Gabriel, 1996)
- Situated Software (Shirky, 2004)
- Aesthetic Programming (Geoff & Soon, 2022)
- Ways of Being (Bridle, 2022)
3. Situated software requires situated documentation (3000)
- Documenting situated practices as an ongoing process. A recipe in the making.
- Techno-solutionism reversed: are we the solution to our tools' problems?
- A praise for partial solutions
- Situated software lifecycle. Inner public, outer public.
- Inner public is the target audience of a situated software. The community where it has been developed. _Private public._
- Outer public is others: different communities that approach to it later on or for different purposes. _Public public._
- What role plays documentation in these two moments?
- Code as common. Documentation as loose interface between different needs.
- Situated documentation is tailored on specific needs, and produced from specific perspectives. How can it resonate with different ones?

Loading…
Cancel
Save