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.
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
- Requirements: An Overview 1m
- Poor Requirements = Project Failure 3m
- Good Requirements = Much Better Chance! 4m
- Requirement Writing Styles 3m
- User Stories 3m
- Traditional (Text-based) Requirements 3m
- Use Cases 6m
- Types of Requirements 4m
- Software Requirements Specification (SRS) 4m
- Summary and Additional Resources 2m
About the author
Amber has been a software developer and technical trainer for over two decades, sharing her expertise in AI, machine learning, AWS, and Power Apps with students around the world. She has a knack for making complex tech topics easy to grasp, whether you’re a developer, designer, or business professional. Amber holds certifications in machine learning, AWS, and various Microsoft technologies, including her experience as a former Microsoft Certified Trainer. With a strong background in visual com... more