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!
4.47 (3037 reviews)
16 563
students
10 hours
content
Apr 2025
last update
$89.99
regular price
What you will 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
Course Gallery
Charts
Students
Price
Rating & Reviews
Enrollment Distribution
Comidoc Review
Our Verdict
This Udemy course aims to teach software documentation within GitHub Wiki, based on 12 main principles of technical writing. Expect a comprehensive exploration of concepts with real-life examples and exercises, but also be aware of repetitive content and occasional quality control lapses. The instructor's expertise and enthusiasm for the field are clear, making this an appealing starting point for software documentation beginners seeking to understand its basics.
What We Liked
- Covers a wide range of technical writing concepts with real-life examples and explanations.
- Excellent introduction to Markdown, GitHub, and Canva for creating infographics in software documentation.
- Instructor demonstrates clear enthusiasm and care for quality technical writing.
- Uses a variety of teaching methods: slides, videos, downloadable resources, and practical exercises.
Potential Drawbacks
- Repetitive content which could have been condensed, leading to an overly long course experience.
- Lacks a deeper dive into specific document types like BRDs, User Guides, etc. as expected from the title.
- Poorly edited and some quality control issues noticed in webinars with repetitive content.
- Some jargon used without explanation might pose difficulty for absolute beginners.
Related Topics
1315060
udemy ID
07/08/2017
course created date
10/07/2019
course indexed date
mybrain2012
course submited by