> So, I've been playng around with the idea of using flowcharts > instead of numbered steps in documentation. > > It seems like it would make complicated procedures, with multiple > options, easier to follow. The drawback, of course, is that it's > not a tool people would be familiar with--except in certain > circles. I guess my general idea is to move away from relying on
I'll sometimes use a flowchart in my documentation, but only if the flowchart makes a complex process MUCG easyer to understand. However, more often, I'll use a flowchart to first understand a really complex process so I can document it. I did this recently where I created a flowchart to describe a software migration process where migration could be on Win, UNIX, HP-UX, or Linux under three different scenarios (same box/same OS, different box/same OS, and different box/different OS). I started with a software architect who had a really good understanding of the overall process, then met with various developers to redefine the process. Once I had a flowchart that the developers agreed on, I was able to bang out a complete draft in record time, somewhere in the area of 4 days for 21 pages of steps. There was a side benefit...while I was documenting, things were discovered in the process by QA that weren't expected by development. However, instead of trying to figure out where in the document the change went and trying to shoewehorn it in, it was easier to rework a section of the diagram, then document it accurately in the manual. John Posada Senior Technical Writer "I think the problem, to be quite honest with you, is that you've never actually known what the question is." _______________________________________________ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. _______________________________________________ Technical Communication Professionals To post a message to the list, send an email to [email protected] To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a blank message [EMAIL PROTECTED] Visit the TCP site at http://www.techcommpros.com To find out more about the list, including archives and your account options, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com If you need assistance with the list, write to [EMAIL PROTECTED]
