FIT2043 is core in in the BSE and an elective for BCS, BCS/BA, BCS/LLB, BSc/BCS, and in a computer science major in BSc. It was introduced as part of the 2006 Faculty restructure, with level 2 introduced in 2007. Previously these degrees had a corresponding unit CSE1402. FIT2043 is based on CSE1402 Technical Documentation for Software Engineers but has been revised slightly due to changes in the pre-requisite units and other core units in the degrees.

July 2018: This unit was disestablished by FEC 3/18 (Item 6.2) as it is no longer required.

June 2016: Add ENG1003 as an alternative prerequisite for transition purposes (as FIT1010 is no longer offered). Discussed via email with CE and BSE course director.

May 2014: Update to objectives to learning outcomes for AQF compliance.

September 2012: Amended prerequisite to allow for the change to first year programming units in 2013. Added FIT1010 as an alternate prerequisite to FIT1002.

Changed practical exam to a final exam as a practical exam in the labs is viable as long as the resources in terms of tutor supervisors, tech services & ITS help are made available for running an effective prac exam. Otherwise, it may be able to run effectively as a formal exam similar to other final exams in the exam halls. Change to be implemented in 2011.

This is a core unit in the BSE, an elective for BCS, BCS/BA, BCS/LLB, BSc/BCS, and the Computer Science major in BSc. It replaces CSE1402 Technical Documentation.

The unit covers all types of technical documentation used in software engineering, both paper-based and online. In addition to developing students writing skills, it covers a range of documentation publication techniques and hypertext and mark-up languages.

The unit provides a number of inter-related foundation skills' necessary for professional development in software engineers, and highly desirable in computer scientists working both with software and hardware.

On successful completion of this unit, students should be able to:

100705

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.

On-campus

Examination (2 hours): 50%; In-semester assessment: 50%

In the past, the final exam was held in the labs. It was a prac exam on latex in 2009. In 2010, XML, latex and some theory questions were part of the Prac lab exam worth 50%.

The update done here on 14/7/2010 reflects the view that it may be offered as a prac exam in the labs or in the exam halls as a formal exam, but must be announced to the students in week 1 of the offering.

A prac exam in the labs is viable as long as the resources in terms of tutor supervisors, tech services & ITS help are made available for running an effective prac exam. Otherwise, it may be able to run effectively as a formal exam similar to other final exams in the exam halls.

Minimum total expected workload equals 12 hours per week comprising:

(a.) Contact hours for on-campus students:

(b.) Additional requirements (all students):

FIT

FIT1010 or FIT1002 or ENG1003