Technical Writing: About Flowcharts
Website design By BotEap.com“A route has no meaning in itself; its meaning is derived entirely from the two points it connects.” – Milan Kundera, 1929-, Czech author, critic
Website design By BotEap.comWhat is a flowchart?
Website design By BotEap.comA flowchart can be defined as a graphical representation of a sequence of operations or steps. In other words, it is an illustration of the various steps involved in a project or process.
Website design By BotEap.comTypically, a flowchart consists of multiple boxes, arrows, and text that are combined to form a sequence.
Website design By BotEap.comWhy create a flowchart?
Website design By BotEap.comThe purpose of a flowchart is to show the different steps of a process in a snapshot. By looking at the flowchart, the viewer should be able to identify the various steps involved in the process.
Website design By BotEap.comFlowcharts can be very useful for a technical writer. If you are working on a complex process, a flowchart can show you the different steps involved in that process. For example, you might be working on a manual on how to troubleshoot the Autopilot Flight Director system for the Boeing 747 aircraft. There are several steps involved in troubleshooting this system. Each step has several sub-steps. By creating a flowchart, you can quickly see which step is taking place at which stage of the process.
Website design By BotEap.comHow to create a flowchart
Website design By BotEap.comWhen you’re working on a complex project, creating the flowchart itself can be a time-consuming task. Here are six simple steps you can follow to create even complex flowcharts:
Website design By BotEap.com1. Start by defining the end result of the process or project. The end result could be anything like completing a user manual, writing a complex software process, installing a new part, or running a test.
Website design By BotEap.com2. List the various steps required to achieve the end result. This will require some research. In complex processes, each step may have a series of sub-steps. The steps needed to create a user manual could be:
Website design By BotEap.comhas. Meet with the SME
b. Research existing documentation
against Videotape the proceedings
d. Take photos
me. create illustrations
F. Develop user guide.
gram. Try user guide
H. Make changes/adjustments
Yo. deliver final product Website design By BotEap.com3. Define the starting point of the project process. This is the first step of the process. For example, the first step could be project planning or research. Website design By BotEap.com4. Write the starting point and the end result. Both should be in boxes with some space between them. Adjust this space according to the number of steps and sub-steps involved in the process. Website design By BotEap.com5. Draw an arrow from the starting point to the final result. Website design By BotEap.com6. Along this arrow, list the various steps in order that are needed to get from the starting point to the final result. Include any secondary steps as necessary. Website design By BotEap.comSome processes may have multiple branches of steps involved. For example, to go from Step 1 to Step 2, there could be three options. I would illustrate this on the flowchart as three separate arrows going from Step 1 to Step 2. Website design By BotEap.comA flow chart is like a road map. It has a start point (A) and an end point (B). Your goal is to get from point A to point B. The flowchart tells you what the process involves. Website design By BotEap.comFor a technical writer, a flowchart can be a very useful tool to illustrate various operations and processes. Before starting your next project, see if you can illustrate the process through a flowchart. It will make life easier for you and your manager or client. The end result will be a better project that is good for your target audience. Website design By BotEap.comNote: Microsoft Visio is good software for creating flowcharts.
b. Research existing documentation
against Videotape the proceedings
d. Take photos
me. create illustrations
F. Develop user guide.
gram. Try user guide
H. Make changes/adjustments
Yo. deliver final product Website design By BotEap.com3. Define the starting point of the project process. This is the first step of the process. For example, the first step could be project planning or research. Website design By BotEap.com4. Write the starting point and the end result. Both should be in boxes with some space between them. Adjust this space according to the number of steps and sub-steps involved in the process. Website design By BotEap.com5. Draw an arrow from the starting point to the final result. Website design By BotEap.com6. Along this arrow, list the various steps in order that are needed to get from the starting point to the final result. Include any secondary steps as necessary. Website design By BotEap.comSome processes may have multiple branches of steps involved. For example, to go from Step 1 to Step 2, there could be three options. I would illustrate this on the flowchart as three separate arrows going from Step 1 to Step 2. Website design By BotEap.comA flow chart is like a road map. It has a start point (A) and an end point (B). Your goal is to get from point A to point B. The flowchart tells you what the process involves. Website design By BotEap.comFor a technical writer, a flowchart can be a very useful tool to illustrate various operations and processes. Before starting your next project, see if you can illustrate the process through a flowchart. It will make life easier for you and your manager or client. The end result will be a better project that is good for your target audience. Website design By BotEap.comNote: Microsoft Visio is good software for creating flowcharts.