Every time I install a program and the instructions tell me to open a Windows Command prompt, I groan. I can never remember how to move back and forth between folders, change to a different drive, see what's in a directory. I know all you IT people out there are rolling your eyes, but for those of us who need a quick reminder, here is a cheat sheet for using the Command prompt. Since all this began with me upgrading from Confluence 3.4.8 to 3.5, I'll use Confluence as an example.
To open the Co...
More
How to write an index
Writing an index for your technical documents can be an intimidating task for a new technical writer.
In fact, often we don't include indexes in online help now, instead relying on the search function. But for some audiences, and obviously for printed documentation, a good index is invaluable.
For example, one system I document is an enterprise application. It includes hundreds of code tables, containing codes for customizing which fields are displayed on the screen, which types of invoice...
More
Recipe for writing a task
A task is one of the fundamental building blocks of good technical writing, and one of the first things new technical writers learn. I was reminded of this when I bought a new cookbook at the end of last year.
In my spare time I love to cook. I have several shelves devoted to cookbooks, and I can spend hours browsing through my books looking for a new recipe to try. One of my favorite cookbooks is Jamie's America, written by Jamie Oliver, with recipes he created while he toured the United Sta...
More