76-774: Software Documentation
This course introduces students to basic practices involved in software documentation for both internal and external audiences. You will learn to understand the purpose of and create documents appropriate for internal audiences (such as Requirements Specifications) and external audiences (user guide, online help, marketing collateral). By the end of the course, you will have a grasp of the standard vocabulary, practices, and methodolgy for creating software documentation alone and as part of a development team. You will better understand the relationship between the software, its objectives and tasks, and the most effective ways of instruction. You will also gain experience in assembling and writing material used in software releases, including procedures, documentation plans, and requirements specifications documents. The course requires a series of homework assignments, including peer-review of course writing. Readings and documentation examples will enhance the projects in providing a bridge between design theory and usage. Students will also use and gain experience with current authoring tools. Subtopics include managing projects and documents, single-sourcing, ensuring quality in documentation, responding to change, and learning the software development
| A | MW | 09:00 am - 10:20 am | PH A22 | De Pellegrin Connelly |