diff --git a/img/frogmouth_aspects.jpg b/img/frogmouth_aspects.jpg new file mode 100644 index 0000000..9782400 Binary files /dev/null and b/img/frogmouth_aspects.jpg differ diff --git a/readme.md b/readme.md index 225b4a2..900130c 100644 --- a/readme.md +++ b/readme.md @@ -23,3 +23,27 @@ Could software documentation: How can situated practices inform the process of documenting software? And how can situated software inform the process of technical writing? + +## Table of contents (draft) + +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 aspects. + +![exploratory documentation aspects + 2 frogmouth birds](img/frogmouth_aspects.jpg) + +More precisely these four aspects will be addressed: + +- **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? + +- **Participation** + Who gets to write, and who is forced to do it? How does development and technical writing interact? Is technical writing a subaltern position in the industry of software development? + +- **Destination** + Who can read documentation? Who can access? Where is the documentation hosted? How does it relate with a bigger context, if any? + +- **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. + +The critical and theoretical research will be weaved around the actual documentations, in order to create a discourse around the development of this practice.