Difference between revisions of "Naming Convention"
Jump to navigation
Jump to search
(Created page with '==Introduction== The establishment of a sound naming convention is fundamental to the easy management of models and their associated files. For suggestions of naming conventions...') |
|||
| Line 1: | Line 1: | ||
| − | |||
The establishment of a sound naming convention is fundamental to the easy management of models and their associated files. For suggestions of naming conventions, refer to Sections 2.2.3 and 2.2.4 of the 2010 TUFLOW Manual. A certain degree of flexibility regarding naming conventions is usually required due to differences between projects and users. However, early establishment of a system has the following benefits:<br> | The establishment of a sound naming convention is fundamental to the easy management of models and their associated files. For suggestions of naming conventions, refer to Sections 2.2.3 and 2.2.4 of the 2010 TUFLOW Manual. A certain degree of flexibility regarding naming conventions is usually required due to differences between projects and users. However, early establishment of a system has the following benefits:<br> | ||
* Easier to understand modelling logic; | * Easier to understand modelling logic; | ||
| Line 6: | Line 5: | ||
* Transferable between different users; and | * Transferable between different users; and | ||
* Ease of handover of the model to the Client or Authorities. | * Ease of handover of the model to the Client or Authorities. | ||
| − | + | Additional to the above list, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present.<br> | |
| + | The naming conventions used within this tutorial are consistent with the recommendations of the TUFLOW user manual. | ||
Revision as of 09:19, 13 September 2011
The establishment of a sound naming convention is fundamental to the easy management of models and their associated files. For suggestions of naming conventions, refer to Sections 2.2.3 and 2.2.4 of the 2010 TUFLOW Manual. A certain degree of flexibility regarding naming conventions is usually required due to differences between projects and users. However, early establishment of a system has the following benefits:
- Easier to understand modelling logic;
- Easier to check for errors;
- Traceability;
- Transferable between different users; and
- Ease of handover of the model to the Client or Authorities.
Additional to the above list, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present.
The naming conventions used within this tutorial are consistent with the recommendations of the TUFLOW user manual.