Technical Writing - About Flowchart

"A route itself has no meaning; its meaning comes entirely from the two points it connects." - Milan Kundera, 1929-, Czech writer, critic

What is a flow chart?

A flowchart can be defined as a graphical representation of a series of operations or steps. In other words, it is a description of the various steps involved in a project or process.

Typically, a flow chart consists of a number of boxes, arrows and text that combine to form a sequence.

Why create a flowchart?

The purpose of the flowchart is to show the various steps of the process in the snapshot. By looking at the flowchart, the viewer should be able to identify the various steps involved in the process.

Flowcharts are very useful for technical writers. If you are working on a complex process, the flowchart can show you the steps involved in the process. For example, you may be writing a manual on how to troubleshoot a Boeing 747 aircraft's Autopilot Flight Director system. Troubleshooting this system involves various steps. Each step has multiple substeps. By creating a flowchart, you can quickly see which step in the process occurs.

How to create a flowchart

Creating a flowchart itself can be a time consuming task when working with complex projects. You can create complex flowcharts in six simple steps:

1. First define the final result of the process or project. The end result may be to complete the user manual, write complex software procedures, install new parts, or perform tests.

2. List the steps involved in achieving the final result. This will require some research. In a complex process, each step can have a series of substeps. The steps involved in creating a user manual might be:

One. Meeting with SMEs
Bay Research Existing Documents
C. Video tape program
d. Take a photo
Create an illustration
F. Development User Guide
G. Test user guide
H. Make changes/adjustments
I. Delivery of the final product

3. Define the starting point of the project process. This is the first step in the process. For example, the first step might be project planning or research.

4. Write down the starting and ending results. Both of these should be in the box with some space between them. Adjust this space according to the number of steps and substeps involved in the process.

5. Draw an arrow from the starting point to the final result.

6. Along this arrow, list the steps required from the start point to the final result. Include any substeps as needed.

Some processes may involve multiple step branches. For example, to go from step 1 to step 2, there are three options. You can describe this in the flowchart as three separate arrows from step 1 to step 2.

The flow chart is like a road map. It has a starting point [A] and an ending point [B]. Your goal is to reach point B from point A. The flowchart tells you what the process involves.

For technical writers, flowcharts can be a very useful tool to illustrate various operations and processes. Before starting the next project, check to see if the process can be illustrated through a flowchart. It will make life easier for you and your manager or client. The end result will be a better project that will benefit your target audience.

Note: Microsoft Visio is a great software for creating flowcharts.

---

Orignal From: Technical Writing - About Flowchart