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
(130)
Level
Beginner
Updated
Jul 20, 2016
Duration
3h 48m
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
(130)
Level
Beginner
Updated
Jul 20, 2016
Duration
3h 48m
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 is a Microsoft Certified Trainer and Microsoft Certified Professional Developer with 15+ years experience working with and teaching Microsoft technologies. She also focuses on professional skills, bridging the gap between techies and non-techies. For her work as a training leader, Amber received Training magazine's 2013 Emerging Training Leader award.

More from the author
Microsoft Dynamics 365 for Field Service
Beginner
1h 18m
Mar 18, 2019
More courses by Amber Israelsen
Section Introduction Transcripts
Section Introduction Transcripts

Course Overview
Hi everyone, my name is Amber Israelsen, and welcome to my course, Technical Writing: Documentation on Software Projects. I've been a developer, author, and technical trainer for 15+ years, and I'm very passionate about this topic. In my years working on software projects, I've found that documentation is often a dreaded task, one that gets pushed to the last minute, or overlooked completely, but good written communication skills will take you far on a software project and in life. In this course, we're going to talk about the importance of documentation in the world of software, look at the writing process, how to get information out of your head and onto paper, dig into some tips and best practices for writing clearly and effectively, and finally, examine common documents on a software project, including requirements, the design or architecture document, code documentation, test plans and test cases, and finally, end user documentation. By the end of this course, you'll have a foundational understanding of technical writing and how to communicate effectively on a software project. Before beginning the course, you should have a good command of the English language and feel comfortable with grammar, sentence structure, punctuation, and so forth. I hope you'll join me on this journey to learn how to communicate effectively with the Technical Writing: Documentation on Software Projects course at Pluralsight.