Technical Writing: How to Write Software Documentation (Udemy.com)

Is the ability to provide relevant information about using your software essential for your customers? Do you find yourself spending hours and hours trying to explain how to use the software? Or are you getting feedback from your clients that your documentation is hard to follow, inconsistent, or maybe even... confusing? 

If you answered with "Yes!" to any of these questions and are willing to invest the time and energy needed to go through this practical course, then this course is for you! 

CNBC cited this course in the article "The 20 hottest job skills companies are looking for right now"

By the end of this course:

1. You will be able to perform the needed steps and start writing documentation as a technical writer.

2. You will be able to explain the process for preparing, organizing, and delivering software documentation for the users of software products.

3. You will be able to create instructional images and graphics needed in your documentation using Canva.

4. You learn and practice how to create software documentation in a GitHub wiki following the instructor's templates for writing in Markdown.

5. You will know how to perform user research using 2 Cards Sorting techniques in Mural.

6. You will be able to identify the different aspects that make documentation a high-quality deliverable.

Also:

• You will find out also which are the core principles for writing software documentation that really helps.

• You will have the chance to try out GitHub wiki editor for writing.

• You will learn about the importance of graphics and which tools you can use to create instructional graphics with ease.

• In the end, you will find out more about information architecture and its importance in software documentation.

• Ultimately, you will have the chance to create your own documentation project even if you have never worked as a technical writer before and have no experience.

  
  

Over the course of the years, the core activities of technical writing professionals have constantly been evolving.

We started as technical writers and focused solely on technical writing. We transformed into information developers who also consider the graphical aspects and design of the content.  Today, we need to bundle together writing skills, design and graphics, video creation, multimedia, metadata, and software development to meet the expectations of our users.

All these assets put together can be described together as user assistance.

JPDocu School of Technical Writing is a training company passionate about technical writing, software documentation, APIs documentation, information architecture, and DITA XML, and helping our students get started and quickly advance in their Technical Writer career.

Our Technical Writing courses are taught as a part of the University courses on Technical Communications at several universities in Europe, as well as a part of the onboarding for new technical writers for many of the best software development companies.

We shape the next generation of technical writers and information developers, by providing them with simple-to-follow and practical, hands-on experiences with technical writing.

For several years now, JPDocu School of Technical Writing has been designing and delivering training for all who want to get started with technical writing. Our students soon get started working as:

1. technical writers (information developers)

2. information architects

3. software developers 

and get ahead in their career!

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

Jordan says: "The goal for me has always been to deliver practical information, to make sure my students 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 technical writers or how they have advanced in their careers using what they have learned in my courses!

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

Unlike other courses out there,  this course is practically oriented. It will help you develop your portfolio and the work samples you need to apply as a technical writer in a software development company.

What will you learn?

This course is designed for beginner technical writers, usually students in IT, and covers the following subjects:

• What is technical writing all about?

• What are the basics of technical writing?

• Which are the common terms you will hear and use in the IT technical writing world?

• How to write technical documentation using GitHub wiki? You will, later on, use this material for creating your portfolio that you will want to add to your CV when you apply for a technical writer job or promotion to a senior developer.

• What is information architecture from a technical writing point of view?

By the end of this course, you will know how to get started writing your user guides, which best practices and rules to consider, and which tools to use for writing.

Note that for better accessibility, the course comes with English and Spanish language captions.

Besides:

• You will also find recorded webinars to give you the feeling you are in the university classroom together with other students doing the actual exercises of the course.

• You will have access to a closed community group, where you can learn together with other students in technical writing.

• You will have the chance to participate in live webinars with the instructor, to get guidance and answers to questions you may have.

• Downloadable materials in the sections to help you as you go through the content and practice what you have learned.