Main Components of a “Release Notes” Document
Release Notes is an important document in software documentation for various reasons. It’s a great source of information when the product development team needs to include the details of what they’ve done, what has been improved and what has been fixed. The release notes typically summarize details that are not highlighted by the main release.…
Read MoreThe Politics of Plain Writing vs. Obfuscation — A Textual Analysis
Usually people don’t write in plain English because they don’t know any better. Sometimes a banker, an engineer, a doctor will write a business letter or a technical document in a way that he or she best knows how – by using jargon and long-winded sentences; clauses awash in passive voice and nonparallel construction, with…
Read MoreAlternative Energy – A Blooming Writing Niche for Technology Writers
There are so many new writing niches sprouting every day. As a technical writer you may want to keep an eye on these developments. If you don’t, you might very well be leaving money on the table. “Alternative (or Renewable) Energy” is one such blooming niche. This sector includes (but probably is not limited to)…
Read More7-Day FREE Technical Writing Course
Here is my beginner-level 7-Day FREE Technical Writing Coursefor those who would like to get a taste of what technical writing in general is all about. +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Day 1, Lesson 1 – Why become a Technical Writer? Day 2, Lesson 2 – How to Research a Technical Document Day 3, Lesson 3 – How to Design…
Read More