Announcements
If you're interested in purchasing a e-book (PDF, ePub, and mobi) version of the Microsoft Manual of Style, 4th ed., go to http://shop.oreilly.com/product/0790145305770.do. When checking out use coupon code MSINT for 50% off the e-book price, which brings the cost down to $11.99. If you'd like to purchase the e-book and print bundle, enter coupon code 4UNEW at checkout, which brings the bundle price down to $19.79 plus tax and shipping.
Current Reading Assignment: WSD Chapters 1 and 3; MMS Chapter 5
Due Date: February 8
For our next class, read Chapters 1 and 3 in Writing Software Documentation (WSD). In addition, start reviewing chapter 5 in the Microsoft Manual of Style (MMS).
Be sure, too, to bring a sample procedure, from either a printed or online source, to class with you. Finally, start looking for a few freeware applications you would be interested in documenting for a procedures assignment. These apps can be for Windows, Mac, Linux, Android, or iOS. Ideally, the app would currently lack documentation yet be small enough for you to learn easily and document.
Links for this evening:
- Artstor Help (faulty parallelism)
- Captionate Help (default manual)
- Configure Windows 95 Dial-Up Networking (too many steps)
- Evernote Help (prose style)
- Gantt Charts in Excel (overstuffed, skips steps)
- IrfanView Help (default manual)
- Ubuntu Documentation (prose style)
Software to download
Handout
Previous Assignment: RoboHelp Tutorial
Due Date: February 8
- Download a PDF copy of part 2 of the tutorial (new posting, password-protected)
- Download an HTML Help copy of part 2 of the tutorial (new posting, password-protected)
- Download a PDF copy of part 1 of the tutorial (check your e-mail for the password)
- Download a HTML Help copy of part 1 of the tutoral (password-protected .zip file)
- Download the replacement System_specs.htm file to import into your Help system's Reference_information folder.
- In the Using_standby.htm file, apply the bullets style and the note style where appropriate.