Logo         Community
  Trog
Services
The Company
Community
Columns
Your Account
Contact Us
 
 
Writing A Software Technical Reference Manual (part 1)
Writing code is easy. Explaining it is a whole new ball game.

| Talking Geek |

If you've been following this column regularly, you already know the basics of writing a user manual. It's pretty simple - put yourself in the mind of the user, and try to answer his or her most frequently asked questions in a concise and effective manner.

This article, however, deals with a different beast, one that is not so easy to tame - the Software Technical Reference Manual (STRM). Written especially for developers, programmers, software architects and other assorted geeks, it's usually filled with technical gobbledygook and complex diagrams illustrating the guts of a software application. It's complicated, intimidating and usually fairly stressful to write...and they'd usually like it yesterday, please.

Over the next few pages, I'm going to offer you a few tips and techniques, culled from my own experiences, that might help in making the process of developing such a manual less painful. As you'll see, proper planning and the right attitude can play an important role here, enabling you to both get your arms around the technical details and compile them into a usable, structured format that serves the needs of your customer.

Let's get going!


How to do Everything with PHP & MySQL
How to do Everything with PHP & MySQL, the best-selling book by Melonfire, explains how to take full advantage of PHP's built-in support for MySQL and link the results of database queries to Web pages. You'll get full details on PHP programming and MySQL database development, and then you'll learn to use these two cutting-edge technologies together. Easy-to-follow sample applications include a PHP online shopping cart, a MySQL order tracking system, and a PHP/MySQL news publishing system.

Read more, or grab your copy now!


more like this print this article  next page
 
Search...
 
In trog...
Logging With PHP
Building A Quick-And-Dirty PHP/MySQL Publishing System
Output Buffering With PHP
Date/Time Processing With PHP
Creating Web Calendars With The PEAR Calendar Class
more...
 
In the hitg report...
Crime Scenes
Animal Attraction
Lord Of The Strings
more...
 
In boombox...
Patience - George Michael
Think Tank - Blur
My Private Nation - Train
more...
 
In colophon...
Hostage - Robert Crais
The Dead Heart - Douglas Kennedy
Right As Rain - George Pelecanos
more...
 
In cut!...
American Chai
The Core
Possession
more...
 
Find out how you can use this article on your own Web site!


Copyright © 1998-2018 Melonfire. All rights reserved
Terms and Conditions | Feedback