Undergraduate - UnitFIT2043 - Technical documentation for software engineers

At the completion of this unit students will have -

A knowledge and understanding of:

• how to organise and write clear technical documentation.
• the different types and roles of technical documentation, including code documentation (literate programming methods, function header documentation), internal designs, external designs, reference manuals, guides and introductory manuals.
• the use of the basic types of tools for producing documentation: editors, text formatters, typesetters, desktop publishers, graphics tools, printing and viewing tools.
• the role of style in writing.
• different approaches to the writing process and which approach best suits the individual student.

Developed attitudes that enable them to:

• be sensitive to the aims and uses of effective technical documentation at all stages in a project.
• be aware of different writing methods and styles and their suitability to different tasks.
• appreciate the wider use of documentation in evaluating, promoting, and supporting projects.
• develop a sensitivity to different reader / audience types.

Demonstrated the communication skills necessary to:

• be able to write effective and clear documentation.
• be able to use one of each major kind of documentation development and delivery tool.