Difference between revisions of "Exercise - Documenting a Flowchart"
| Line 14: | Line 14: | ||
| − | ==Benefits of | + | ==Benefits of documentation== |
Documenting your flowchart is very useful - it allows other users to understand your flowchart and allows them to learn and even add to your flowchart to help produce the final program and increase efficiency throughout the system. | Documenting your flowchart is very useful - it allows other users to understand your flowchart and allows them to learn and even add to your flowchart to help produce the final program and increase efficiency throughout the system. | ||
| Line 21: | Line 21: | ||
| − | ==Adding comments | + | ==Adding comments== |
Revision as of 09:01, 18 July 2013
<sidebar>Sidebar: Adding Finishing Touches</sidebar> This exercise assumes that you have created the program described in exercises Configuring Icons and Variables and Adding Devices to a Program.
Documenting the flowchart is essential in some projects, although we have properly labelled the icons, a few comment icons helps to further explain the program and the process in further detail to aid expansion and helps others understand the system.
Load the Flowcode flowchart
- Open the flowchart, called 'Lamp1.fcf' which you created in the exercise Adding Devices to a Program.
- (For help with this, see the article Opening an Existing Flowchart)
Benefits of documentation
Documenting your flowchart is very useful - it allows other users to understand your flowchart and allows them to learn and even add to your flowchart to help produce the final program and increase efficiency throughout the system.
Adding comments to document your flowchart is extremely easy and very useful, using comments allows you to clarify the process, purpose and function of your program and allows others to understand it so they can see what is going on and learn from it and even help to develop the program, even by suggestion a more efficient method or directly editing a icon to function more effectively.
