From 6823e84dc41ccf0ddd8b9ef025fcb1f769c501b7 Mon Sep 17 00:00:00 2001 From: "kam (from the studio)" Date: Thu, 19 Jan 2023 18:59:56 +0100 Subject: [PATCH] an index and another one ! --- readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/readme.md b/readme.md index 854ada4..0f05700 100644 --- a/readme.md +++ b/readme.md @@ -101,3 +101,49 @@ The critical and theoretical research will be weaved around the actual documenta 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. Context around software, besides technicality + 2. Introduce issues around software and documentation + + 1. Biased and hostile environments + 2. Evergrowing complexity and black box + 3. The universal solution™ + + 3. Propose documentation as a way to address these issues + 1. Welcoming readers + 2. Lowering barriers and create entry points + 3. Multiple strategies to tackle on problems + +2. Documentation as an interface _(3000)_ + Aknowledge documentation as a meeting point for different knowledges, as vantage point from where to question software culture. + + 0. Define software documentation + + 1. Small historical overview: from printed manuals to discord servers + 2. Dyataxis framework: Reference, How-to, Guide, Tutorial + + 1. Actors and hierarchies + + - No one wants to write documentation, or pay someone to do it + - Is writing documentation subaltern work? + + - Outside of time, Ullman + - Into the ground C++, Gabriel + - Debugging (P5js Education Working Group, 2015) + - Post-meritocracy manifesto (Ehmke, 2018) + - Read the feminist manual (Karayanni, 2021) + + 2. Thinking beside software + + - Close to the code, to the user, the developer + - Making sense out of the black box + - Multiple layers and entry points + + 3. Welcoming alternatives + +3. Situated software requires Situated documentation (3000)