Technical Writing: Documentation on Software Projects
Pluralsight
Course Summary
This course covers the fundamentals of writing effective software documentation. Whether you need to document requirements, architecture/design, code, test plans, or manuals for end users, this course gives you tips and best practices to do it all.
-
+
Course Description
The term "technical writing" can mean many different things, depending on your field and role. But at its core, it’s about communicating information. In this course, Technical Writing: Documentation on Software Projects, you'll learn how to write documentation for a software project, including requirements, the architecture/design document, code documentation, test plans and test cases, and end-user documentation. First, you'll learn how important documentation is in the world of software and how the writing process works. Then, you'll learn some tips and best practices for writing clearly and efficiently. Finally, you'll learn about common documents on a software project. When you're finished with this course, you'll have a foundational understanding of technical writing and how to communicate effectively on a software project.
-
+
Course Syllabus
Course Overview- 1m 28s
—Course Overview 1m 28sIntroduction to Technical Writing- 16m 54sThe Writing Process- 28m 13sWriting Tips and Best Practices- 32m 54sLayout and Design- 39m 1sDeliverables: Requirements- 33m 0sDeliverables: Design/Architecture- 12m 53sDeliverables: Code Documentation- 20m 11sDeliverables: Test Plans and Test Cases- 15m 48sDeliverables: End-user Documentation- 15m 56sConclusion and Additional Resources- 11m 39s