6 points, SCA Band 1, 0.125 EFTSL
Undergraduate - Unit
Refer to the specific census and withdrawal dates for the semester(s) in which this unit is offered.
Faculty
Unit guides
Synopsis
This unit covers problems with paper-based and on-line documentation; types of technical documentation used in software engineering; the role of various different forms of technical documentation in the software development process; document specifications; the context of technical writing; the writing process (analysis, planning, generation, testing, revision and maintenance of written texts); document publication techniques (such SGML, LaTeX, and/or XML); the role of hypertext, hypermedia and markup languages in technical documentation; small-volume and large-volume hypertext; collaborative hypertext; intelligent hypertext.
Outcomes
On successful completion of this unit, students should be able to:
- produce well-organised and clear technical documentation;
- explain the purposes and uses of the different types of technical documentation, including code documentation, internal design documentation, external design documentation, reference manuals, guides, and tutorials;
- distinguish between the different types of tools for producing documentation (text editors, formatters, typesetters, desktop publishers, graphics tools, printing and viewing tools) and select tools that are appropriate for specified applications;
- produce technical documentation that is written in an appropriate style and at an appropriate level for different classes of readers, including fellow software engineering professionals, managers, clients, and end-users;
- evaluate the correctness, appropriateness, and usability of written documentation, and apply strategies to improve these;
- correctly use specified software tools to create and publish technical documentation.
Assessment
Examination (2 hours): 50%; In-semester assessment: 50%
Workload requirements
Minimum total expected workload equals 12 hours per week comprising:
- Contact hours for on-campus students:
- Two hours of lectures
- One 2-hour laboratory
- Additional requirements (all students):
- A minimum of 8 hours independent study per week for completing lab and project work, private study and revision.
See also Unit timetable information
Chief examiner(s)
This unit applies to the following area(s) of study
Prerequisites
Prohibitions
CSE1305, CSE1402