Difference between revisions of "Naming Convention"

From Tuflow
Jump to navigation Jump to search
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 Naming Conventions section of the 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 the Naming Conventions section of the 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;
 
* Easier to check for errors;
 
* Easier to check for errors;

Revision as of 09:01, 17 November 2016

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 the Naming Conventions section of the 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.