User Tools

Site Tools


tutorials:file_management

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
tutorials:file_management [2026/09/14 23:05] chkuotutorials:file_management [2026/09/17 11:20] (current) chkuo
Line 37: Line 37:
 ===== Naming and version control ===== ===== Naming and version control =====
   * File names   * File names
-    * Do: short and informative. Include information such as project id, keyword (e.g. manuscript, report, keyword of figure/table), version or date +    * Do: short and informative. Include information such as project id, keyword (e.g. manuscript, report, keyword of figure/table), and version (or date) 
-      * Project id as a useful system+      * Proper length is affected by directory structure; files in multi-level directories tend to have shorter names 
 +      * If the files (but not the directory structure) are to be shared, proper length may change. For example, "~/work_folder/manuscripts/project_X/draft/manuscript_v02.docx" works nicely in one's own computer, but for sharing, "projectX_manuscript_v02.docx" probably works better.
     * Avoid:      * Avoid: 
       * Long names that are difficult to read (e.g., full title of the manuscript)       * Long names that are difficult to read (e.g., full title of the manuscript)
Line 49: Line 50:
       * Alternatively, use dates for version numbers; depends on how frequent the files are updated       * Alternatively, use dates for version numbers; depends on how frequent the files are updated
       * Optional: Add initials if multiple people are involved in the project       * Optional: Add initials if multiple people are involved in the project
 +      * Optional: Add additional info; for example, "defense_final.pptx" is not a good idea, "defense_v09_presented.pptx" may be more accurate. If modifications were made after the presentation (committee gave useful suggestions, slides will be reused for job interview), then those modifications can be incorporated immediately after defense into "defense_v10.pptx". With all versions in the some file folder, it should be clear which one is the latest.
     * When in doubt, save as a new version     * When in doubt, save as a new version
     * Recommended: In early versions of manuscript drafts, add a short section in the beginning of the document to explain the major changes made     * Recommended: In early versions of manuscript drafts, add a short section in the beginning of the document to explain the major changes made
tutorials/file_management.1789398335.txt.gz · Last modified: by chkuo