Technical Writing: Documentation on Software Projects

Focused View

Amber Israelsen

3:47:23

492 View

1. Course Overview

1. Course Overview.mp4

01:28

2. Introduction to Technical Writing

1. Let Me Tell You a Story....mp4

03:01

2. But Im a Developer, Not a Writer....mp4

04:32

3. Why Technical Writing Is Important (Even for Developers).mp4

05:50

4. Technical Writing - An Overview.mp4

01:32

5. Course Outline and Prerequisites.mp4

01:57

3. The Writing Process

1. The Writing Process - An Overview.mp4

01:51

2. The Planning Phase - Purpose.mp4

03:12

3. The Planning Phase - Audience.mp4

06:19

4. The Planning Phase - Delivery.mp4

00:57

5. The Research Phase.mp4

06:22

6. The Writing Phase.mp4

02:04

7. The ReviewingEditing Phase.mp4

04:33

8. The Launch Phase.mp4

01:15

9. Summary.mp4

01:34

4. Writing Tips and Best Practices

1. Writing Tips and Best Practices - An Overview.mp4

02:02

2. Accuracy.mp4

03:17

3. Clarity.mp4

08:58

4. Conciseness.mp4

05:30

5. Tone.mp4

02:12

6. Tense.mp4

02:07

7. Grammar, Spelling, and Terminology.mp4

07:01

8. Summary and Additional Resources.mp4

01:44

05. Layout and Design

01. Layout and Design - An Overview.mp4

00:29

02. Typography - The Basics.mp4

04:49

03. Typography - Guidelines.mp4

04:52

04. Design Principles - An Overview.mp4

01:01

05. Alignment.mp4

03:33

06. Proximity.mp4

02:37

07. Contrast.mp4

06:58

08. Whitespace.mp4

02:28

09. Page Design Elements.mp4

06:06

10. Visuals.mp4

03:20

11. Summary.mp4

02:42

06. Deliverables - Requirements

01. Requirements - An Overview.mp4

01:03

02. Poor Requirements = Project Failure.mp4

02:49

03. Good Requirements = Much Better Chance!.mp4

04:06

04. Requirement Writing Styles.mp4

03:09

05. User Stories.mp4

02:58

06. Traditional (Text-based) Requirements.mp4

02:50

07. Use Cases.mp4

06:15

08. Types of Requirements.mp4

03:54

09. Software Requirements Specification (SRS).mp4

04:12

10. Summary and Additional Resources.mp4

01:39

7. Deliverables - DesignArchitecture

1. DesignArchitecture Documentation - An Overview.mp4

01:04

2. Software Design Document (SDD).mp4

03:45

3. SDD Sections - Introduction.mp4

02:11

4. SDD Sections - System Architecture.mp4

01:21

5. SDD Sections - Detailed System Design.mp4

01:11

6. SDD Sections - Data Design.mp4

00:44

7. SDD Sections - User Interface.mp4

01:15

8. Summary.mp4

01:21

8. Deliverables - Code Documentation

1. Code Documentation - An Overview.mp4

01:07

2. Code Comments.mp4

06:56

3. API Documentation.mp4

03:24

4. API Documentation - Demo.mp4

04:15

5. README Files.mp4

03:08

6. Summary.mp4

01:18

9. Deliverables - Test Plans and Test Cases

1. Test Plans and Test Cases - An Overview.mp4

02:06

2. Test Plan - An Example.mp4

07:06

3. Test Scenarios and Test Cases.mp4

00:48

4. Writing Test Cases.mp4

04:07

5. Summary and Additional Resources.mp4

01:39

10. Deliverables - End-user Documentation

1. End-user Documentation - An Overview.mp4

01:43

2. User Guides.mp4

01:06

3. User Guides - An Example.mp4

05:01

4. Quick Reference Guides.mp4

02:09

5. Release Notes.mp4

00:58

6. Release Notes - An Example.mp4

03:26

7. Summary.mp4

01:29

11. Conclusion and Additional Resources

1. The Beginning of the End.mp4

00:48

2. Recap - Technical Writing and the Writing Process.mp4

02:10

3. Recap - Writing Best Practices, Layout, and Design.mp4

01:43

4. Recap - Deliverables.mp4

04:22

5. The End of the Story.mp4

00:26

6. Additional Resources.mp4

02:08

Description

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.

More details

User Reviews

Rating

average 0

Total votes0

Focused display

Technical Writing

Amber Israelsen

Instructor's Courses

Amber has been a software developer and technical trainer since the early 2000s. She holds certifications for AWS and a variety of Microsoft technologies. In recent years, she has focused on AWS, Machine Learning, Azure, Power Apps, Dynamics 365, SharePoint and .NET, teaching students around the world. She also works to bridge the gap between developers, designers and businesspeople with her expertise in visual communication, user experience and business/professional skills.

Pluralsight

View courses Pluralsight

Pluralsight, LLC is an American privately held online education company that offers a variety of video training courses for software developers, IT administrators, and creative professionals through its website. Founded in 2004 by Aaron Skonnard, Keith Brown, Fritz Onion, and Bill Williams, the company has its headquarters in Farmington, Utah. As of July 2018, it uses more than 1,400 subject-matter experts as authors, and offers more than 7,000 courses in its catalog. Since first moving its courses online in 2007, the company has expanded, developing a full enterprise platform, and adding skills assessment modules.