Naming convention for wiki/svn/etc...

Victoria Moulder vmoulder at sfu.ca
Thu Jan 7 15:10:43 UTC 2010


Hi James,

In regards to your comments as a practice I've tried to stay away from using dashes, spaces and upper case letters in naming conventions, mostly because servers can render them differently. 

e.g., 
091021_fe_kiosk_wireframes_jmvm_d4.pdf 

Best, Vicki 


----- Original Message -----
From: "Leah Maestri" <leahm at sfu.ca>
To: "James William Yoon" <james.yoon at utoronto.ca>
Cc: "fluid-work" <fluid-work at fluidproject.org>, "jess" <jess at jessmitchell.com>, "Victoria Moulder" <victoria_moulder at sfu.ca>
Sent: Wednesday, 6 January, 2010 11:52:40 GMT -08:00 US/Canada Pacific
Subject: Re: Naming convention for wiki/svn/etc...

This is great James. +1 with the date format "091021"

Lee



----- Original Message -----
From: "James William Yoon" <james.yoon at utoronto.ca>
To: "Leah Maestri" <leahm at sfu.ca>
Cc: "fluid-work" <fluid-work at fluidproject.org>, "jess" <jess at jessmitchell.com>, "Victoria Moulder" <victoria_moulder at sfu.ca>
Sent: Wednesday, January 6, 2010 11:45:31 AM GMT -08:00 US/Canada Pacific
Subject: Re: Naming convention for wiki/svn/etc...

I like this naming convention, but would suggest a couple of small changes: 

Date(yy-mm-dd)_ProjectNameAbbr_SubProject_TypeOfWork_[TitleOrDescription_]Authors_DraftNumber 

e.g., 
09-10-21_FE_Kiosk_Wireframes_JM-VM_D4.pdf 
09-10-21_FE_Mobile_Wireframes_Artifact-View_JM-VM_D4.pdf 

Changes and reasoning: 
- Date in yy-mm-dd format so that when filenames are sorted by name, files are automatically sorted properly by authoring date 
- Order of project name, sub-project, type of work, and title/description in increasing granularity (project > sub-project > type of work > title) 
- "D4" to indicate draft number instead of just "4", since some operating systems append a -x to the filename duplicates 

(additional thought: 

091021 - FE - Mobile - Wireframes - ArtifactView - JMVM - Draft4.pdf 

seems more readable to me than 

09-10-21_FE_Mobile_Wireframes_Artifact-View_JM-VM_Draft-4.pdf 
) 

Cheers, 
James 


On Wed, Jan 6, 2010 at 1:29 PM, Leah Maestri < leahm at sfu.ca > wrote: 


Hi all, 

I'm resurrecting this in light of a recent re-org to the wiki we did. The last discussion centered around the following naming convention: 

Date(MM-DD-YY)_project name abbreviation_ type of work description_title_author(s) abbreviated_version number. 

So as an example: 

10-21-09_FE_wireframe-sketches_kiosk-v4_JM-VM_1.jpg 
10-21-09_FE_wireframe-sketches_kiosk-v4_JM-VM_2.jpg 
10-21-09_FE_wireframe-sketches_kiosk-v4_JM-VM_3.jpg 

etc... 

I know people thought it was redundant to have the date stamped in the title, but for the wiki this is actually helpful as we need to do "versioning" somewhat manually and it's helpful to know what docs were created at different times. 

Feedback? 

Best, 
Lee 




More information about the fluid-work mailing list