Technical Writing: How to Write Software Documentation

Learn a proven strategy for writing software docu in GitHub wiki based on the 12 main principles of technical writing!

Created by: JPDocu School of Technical Writing
WE TEACH SOFTWARE DOCUMENTATION AND DITA! 50K+ Students!

What Will I Learn?

• Learn what is required to start working on the software documentation for an app
• Learn how to write documentation in GitHub Wiki using Markdown
• Try out tools and infrastructure that helps you immediately get started writing your help content
• Learn how to prepare, structure and develop information that help users use your software
• Learn the basics of structured writing
• Understand the importance of metadata and taxonomies to improve for your user assistance assets findability
• Learn how to make graphics for your software documentation using Canva

Requirements

• You will need a PC or a laptop where you can develop content assignments or install particular software we will be using on trial basis in the course of the training

Target audience

• Software developers who want to gain practical knowledge on how to offer help for the users of software products
• Students who work on their software development projects and now struggle to create the documentation delivery for their app
• If you pursue career as a technical writer, developer, architect, manager or product owner
• Business analysts who want to know the basics of technical writing
• Technical Writers and Information Developers