76 474 - Software Documentation

Institution:

Carnegie Mellon University

Subject:

Description:

This course teaches best practices for creating software documentation for both internal audiences (use cases, requirements specifications) and end users (online help, guides, marketing collateral). You will learn the importance quality documentation plays in the success of a product and the user's experience, and the importance of understanding (and meeting) that user's needs. The course emphasizes quality task-oriented writing and focuses on the basic skills needed to educate and guide users, while introducing important industry trends like topic-based authoring, single sourcing and reuse, and DITA. Students will complete a series of short homework assignments and several larger projects to reinforce the principles and provide experience in all phases of creating software documentation, including peer review. Readings and published documentation examples will provide a bridge between theory and practice. No textbook required, but students may be required to purchase necessary software (a DITA editor).

Credits:

9.00

Credit Hours:

Prerequisites:

Corequisites:

Exclusions:

Level:

Instructional Type:

Lecture

Notes:

Additional Information:

Historical Version(s):

Institution Website:

www.cmu.edu/

Phone Number:

(412) 268-2000

Regional Accreditation:

Middle States Association of Colleges and Schools

Calendar System:

Semester

The Course Profile information is provided and updated by third parties including the respective institutions. While the institutions are able to update their information at any time, the information is not independently validated, and no party associated with this website can accept responsibility for its accuracy.