CSE1402

Technical documentation for software engineers

(IT)

6 points + Two 1-hour lectures and one 2-hour tutorial/practical class per week + Second semester + Clayton + Prohibitions: CSE1305, SFT2203

Synopsis: Problems with paper-based and on-line documentation; types of technical documentation used in software engineering; document specifications; minimalist design philosophy; graphic design of technical documentation; the context of technical writing; the writing process (analysis, planning, generation, testing, revision and maintenance of written texts); document publication techniques (including SGML and LaTeX); the role of hypertext, hypermedia and markup languages in technical documentation; small-volume and large-volume hypertext; collaborative hypertext; intelligent hypertext.

Assessment: Assignments and practical work: 85% + Examination: 15%