Home » Computers » Software » Operating_Systems » Unix » IRIX

Documentation

InfoSearch - techpubs.sgi.com - Service provided by Silicon Graphics Inc. for searching online books, man pages, and release notes. Rate this

Articles in this category:

• Are You Maintaining Your Documentation Correctly? - As I've said in many eZines, you must write stuff down. The other day, an interviewer asked, "How many pages you written?" "Somewhere around 30,000 pages delivered, not including thousands of draf...
• Are you maintaining your documentation correctly? - ============================================================
  Are you maintaining your documentation correctly?
  ============================================================
  
  As I've said in many eZines, you must write stuff down.
  
  The ot...
• Successful Documentation Projects - Part 2 of 3 - `Specifying - ...
• The Value of Adding Images to Technical Documentation - It’s cliché, but true—a picture does paint a thousand words. This is an important message to remember when writing any sort of user documentation, such as an installation guide or an instruction man...
• Successful Documentation Projects – Part 2 of 3 – ‘Specifying’ - So you’re responsible for managing a documentation project. You know who your audience is, what they’re trying to achieve, how the product enables them to achieve it, and what the audience requires of the help. Now it’s time to spec out your intentions. ...
• Successful Documentation Projects – Part 3 of 3 – ‘Writing’ - So you understand your user documentation project and you’ve specced it out. Now you’re ready to write. Here’s some tips to help you on your way. This article isn’t about the actual writing itself; it’s about the things which go along with the writing. (...
• Successful Documentation Projects - Part 3 of 3 - `Writing - ...
• Successful Documentation Projects - Part 1 of 3 - `Understanding - ...
• Don’t Forget the Internal Software Documentation - Internal documentation. It’s one of the most frequent casualties in software development.
  
  It’s not hard to see why. For most companies, time is money, and they frequently find themselves scrambling to release a product. It can therefore be tempting...
• Successful Documentation Projects – Part 1 of 3 – ‘Understanding’ - The creation of user documentation is a big component of any software project. Unfortunately, it’s often undervalued and left to the last minute. But that doesn’t mean it should be without a good management plan.
  
  This is the first in a series of th...