Please use this identifier to cite or link to this item: http://hdl.handle.net/1946/5052
This thesis covers the writing of user documentation for a company intranet. The documentation in question is of two kinds; on the one hand, guidance level documentation or a user manual containing procedures, and, on the other, teaching level documentation or tutorials. The user manual describes the steps involved in using individual intranet features, whereas the tutorials lead users through tasks that reflect real-world situations.
The coverage in the thesis consists of a general discussion about technical writing in order to familiarise readers with that genre. It then moves on to describe the main steps involved in writing the user manual and the tutorials. The discussion focuses on, for example, the research phases of task and audience analysis, the organisation of content into procedural information and tutorials, the writing of instructions, the use of tables and images to present technical content, index creation, and text editing. Finally, an appendix contains both types of documentation.
In technical writing as in other genres, authors are encouraged to consider whether their writing accomplishes its purpose and whether it fits the characteristics of its intended audience. In this thesis, I seek to illustrate how those points are connected to the above-mentioned steps involved in writing the intranet documentation. In other words, I reason that the documentation is an example of writing which aims to accomplish its purpose and meet the needs of its readers.