diff --git a/readme.md b/readme.md index 4e0f4ce..957bdba 100644 --- a/readme.md +++ b/readme.md @@ -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) + 1. Coding Contingencies _(2000)_ 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™ - 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 2. Lowering barriers and create entry points 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 - 1. Small historical overview: from printed manuals to discord servers - 2. Dyataxis framework: Reference, How-to, Guide, Tutorial + 1. From printed manuals to discord servers _(small historical overview)_ + 2. Dyataxis framework: Reference, How-to, Guide, Tutorial. 1. Welcoming diverse knowledges - - Who is writing? - - Who will read? + - _Who is writing?_ + - 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) - - - Who is making of software? - - A crowd besides developers - - Post-meritocracy manifesto (Ehmke, 2018) + - Programming for the millions (Ullman, 2016) 2. Lowering barriers and create entry points - - Paths through complexity - - Demistifying - - - Bridle Welcome to console + - _Who is addressed?_ + - [welcome.js](https://jamesbridle.com/works/welcome-js) (Bridle, 2016) - Debugging (P5js Education Working Group, 2015) + - _Who can access?_ + - Wheatering software winter (100R, 2022) + 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?