Sean Hower said... > > 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 words--similar to model instructions. > Radical, I know, but it would be an experiment worth trying I think. > > Any thoughts for general discussion? >
Sorry for the late response, but I took advantage of the long weekend... I write a lot of process and procedure documents in my position, and I found early on that flowcharts are a great way for me to get a handle on how the process goes. In fact, when I am completing my initial research into what needs to be documented and what processes or procedures must be covered, I usually build one or more flowcharts before I do an outline. The flowcharts help two groups of people. For my SMEs, it gives them a visual representation of how the document will be laid out, and because it's a linear, logical way of laying out the information, it allows them to have input if they think I need to cover a certain process or procedure before or after other topics. For me, the flowchart gives me a sense of where I have any holes in my research or where I may need to find more information. Once you start flowcharting a process, it's pretty easy to spot when you have a box where you know you need something, but the best you can come up with is "miracle happens here." Then you know where you need to go to get more complete information for the document. On more than one occasion, I've had requests to turn these flowcharts into deliverable documents for SMEs, project sponsors, and executive staff. Of course, YMMV, but my belief is this: if you think flowcharts will help you understand a complex process better and develop a more logical order and layout for your document, then you should employ them. It doesn't matter if you will ever put them in a document or if anyone else will see them. If it helps you write a better deliverable, then you owe it to your project sponsors, your SMEs, and your target audience to use any tool you can to create a better document. And now for my introduction (since I've not done so yet): I've been lurking here for a few weeks, and I've (mostly) lurked on the TECHWR-L list for about a year and a half. I'm employed as a Technical Writer by the major CATV/HSD/Digital Voice Services provider in the Orlando, Florida area. I've been in my current position a year and a half, and I write mostly internal documentation for audiences ranging from field technicians and technical support to engineering and telecommunications. We recently won the naming rights for the new on-campus football stadium being built by the local university (my alma mater), and I'm currently working on a pet project with our Public Relations department to design some creative dual-logo giveaways related to that sponsorship. In 2006 I've taken a course to strengthen my skills in XML and XHTML markup, since we're projecting that more and more of our projects will be moving from paper-based to web-based deliverables in the next 12 to 36 months. I've been an active member of the STC since April of 2005, and outside of work I'm active in some alumni- and faith-based volunteer projects on a regular basis. I'm a homeowner, I have a car, an aging parent, I'm single, and I have no kids... oh, wait a minute--it's not that kind of intro, is it? ;-) CONFIDENTIALITY NOTICE: This e-mail may contain information that is privileged, confidential or otherwise protected from disclosure. If you are not the intended recipient of this e-mail, please notify the sender immediately by return e-mail, purge it and do not disseminate or copy it. _______________________________________________ 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]
