Using hypertext and paper creates a successful trip for the user of an interactive, mainframe software system. Building integrated, complementary documentation requires thoughtful planning, careful organization, and skillful implementation. The resulting product needs the cooperation of the entire team.
The demand for help and hypertext systems has created a problem for many documentation departments, particularly those in smaller companies and inexperienced in creating these forms of online documentation. The scarcity of existing literature compounds this problem. This document provides writers in small companies with limited resources some suggestions to facilitate hypertext project management, planning, design, editing, and usability testing. Also discussed is how to select a hypertext package.
A technical writer’s blog on Wordpress Linking to external blog posts from our documentation with 3 comments At work, we’ve just started a new set of documentation pages called “Tips of the Trade“. The project is still in the early stages. I thought other tech writers might be interested, so I’m blogging about it now. There will be a page for each of the products we document. The pages contain a set of links to useful blog posts written by people out there on the www. It’s a way of giving our readers more information and a way of involving external bloggers, developers and authors in our documentation.