Udemy

Platform

English

Language

Software Engineering

Category

Technical Writing: A Quick Start to Software Documentation

A quick and direct overview of the end-to-end processes for writing software documentation

4.26 (157 reviews)

Technical Writing: A Quick Start to Software Documentation

Students

1 hour

Content

Jun 2021

Last Update
FREE
Regular Price

EXCLUSIVE OFFER
Exclusive  Offer
Unlimited access to 30 000 Premium SkillShare courses
30-DAY FREE TRIAL

What you will learn

What is Software Documentation

Who is a Technical Writer and What Technical Writers Do

What is the Writing Process to Develop Software Documentation


Description

In this quick start course, we start with a quick and direct overview of the end-to-end documentation creation processes.


By the end of this course, you should get a basic understanding of what technical writing in software documentation is all about. You will be able to name the main assets (deliverables for your customers) that you create using technical writing skills and techniques. For example, such are the software documentation itself, images, as well as instructional videos, and multimedia.


For several years now, JPDocu School of Technical Writing has been designing and delivering training on user assistance for:

  • technical writers (information developers)

  • information architects

  • software developers 


The instructor, Jordan Stanchev, a User Assistance Development Architect has personally trained hundreds of people in the classroom, online courses, universities, and internally at a Fortune 500 company! 

Jordan says: "The goal for me has always been to deliver practical information, to make sure my trainees get ready for delivering real content, right after the course is over. 

I am so proud of my students who come back to me and share how they have started their first job as a technical writer or how they have advanced in their career using what they have learned in my courses!

That's the reason I have started devoting my time to teaching technical writing skills, on top of my regular job as a User Assistance Development Architect."

So, enroll now and see how easy and simple it is to deliver help for your software app customers!



Content

A Quick Start to Software Documentation

Introduction

Who is a Technical Writer and What Technical Writers Do

Who Does Technical Writing?

What is the Result from Technical Writing?

The Job of the Technical Writer

Types of Documentation

Functional Documentation

Functional Documentation Example

Functional Documentation in Software Documentation

Strategy for Writing Functional Documentation

Task Oriented Documentation

Strategy for Writing Task-Oriented Documentation

Task Oriented Documentation Example

Technical Writers in Development Team

The Technical Writing Process

Exercise

The Ultimate Purpose of the Technical Writer


Reviews

J
Julie14 June 2021

I think this class is a good first overview of technical writing. I wish the teacher had shown more examples of what he was talking about in the theory lectures, as he mainly stayed on one Powerpoint slide. I also wish he had gone into some detail about each step of the technical writing process he has.

B
Brandon8 May 2021

The content of this course is fairly basic and quick, but it's well thought out and there's a lot of good points. Great opening course for technical writing.

S
Steffi24 April 2021

The course gives a good basic overview for beginners in the technical writing field. The material is explained well and with simple language and examples. Some more interaction or exercises in between chapters would have made the course more interesting.

T
Trenetta13 April 2021

Very useful and helpful information. It clarifies the industry and the multi-ways I can use the skill.

Y
Yahia3 April 2021

A very good presentation to someone who’s new to this field, thank you sir for your generosity and contribution to the Technical writing field!

A
Ashu27 March 2021

In this session, I got a basic overview of what technical writing actually is and how it works. Feels great!

E
Elisa10 March 2021

Having already done some technical documentation, I feel like this was a bit too easy/obvious at times. But it was clear and interesting!

M
Magdalena9 March 2021

It was a good source of information for somebody like me who just starts a journey in techwriting world.

B
Bernadett3 March 2021

Great introduction of what technical writer job is. I now have a clear understanding of the role. Thanks a lot!

G
G24 February 2021

I am an experience tech writer, am now preparing for interviews.. as i have time, i thought i will start from the beginning :)

J
Joanna18 February 2021

I am a professional technical writer, so all information was evident to me. However, I believe that for beginners it is very informative training. Great structure, good content, well-planned lectures. Thanks, Jordan!

L
Liezl2 February 2021

A handy introduction to the field for someone who knew very little about it. Good overview and examples given.

B
Beverly27 January 2021

I am realizing that I have been doing technical writing for many years as a Project Manager and Technical Consultant and Business Person. I am excited to learn new methods to organize and produce better concept deliverables!

E
Eric11 December 2020

This was a good match because I'm looking for greater detail about what's involved with Technical Writing.


3576299

Udemy ID

10/18/2020

Course created date

11/21/2020

Course Indexed date
Bot
Course Submitted by

Twitter
Telegram