© Ugur Akinci Release Notes is a standard technical document that all software companies produce to let their customers know about new features and fixed “bugs” of every major release. Also included would be “known issues” and other issues that the users are updated about.
Monthly archives for July, 2012
© Ugur Akinci How would you organize a Table of Contents (TOC) when documenting software? What’s the best way to do that? A common beginner’s mistake is to compile a TOC by such GUI (Graphic User Interface) components as tabs and menus. For example, let’s say you are documenting how to use MS Word. One […]
© Ugur Akinci Writing is also about finding joy and contentment in this life. I continue to believe that, when used correctly, writing can actually become a wonderful tool, a great platform, to catapult us to our next level of human potential. It can help us make our peace with who we are and what […]
By Steve Williams As a technical writer, you strive for Accuracy, Clarity and Readability. But where do you strike the balance? Although the definition of Substance ought not to change, it is influenced by evolving trends in Style. Substance is, of course, ever the more important part of technical writing. But Style is what keeps […]
By Natalie Eastaugh When used in an engineering context, the term ‘Technical Documentation’ is typically referring to any kind of documentation which is used to describe the functionality, architecture and also the handling of any technical product as well as any given product which is either under development or even currently in use. This specialist […]