Technical Writing: Documentation on Software Projects

by Amber Israelsen

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.

What you'll learn

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.

Table of contents

Course Overview
1min

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.

Ready to upskill? Get started