Technical Writing: Documentation on Software Projects

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 info
Rating
(205)
Level
Beginner
Updated
Jul 20, 2016
Duration
3h 47m
Table of contents
Course Overview
Introduction to Technical Writing
The Writing Process
Writing Tips and Best Practices
Layout and Design
Deliverables: Requirements
Deliverables: Design/Architecture
Deliverables: Code Documentation
Deliverables: Test Plans and Test Cases
Deliverables: End-user Documentation
Conclusion and Additional Resources
Description
Course info
Rating
(205)
Level
Beginner
Updated
Jul 20, 2016
Duration
3h 47m
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.

About the author
About the author

Amber has been a software developer and technical trainer since the early 2000s. She holds certifications for AWS and a variety of Microsoft technologies. She also focuses on user experience and professional skills training, bridging the gap between techies and non-techies.

More from the author
Developing Amazon Alexa Skills
Intermediate
1h 35m
Dec 14, 2020
More courses by Amber Israelsen