Naming convention for wiki/svn/etc...

James William Yoon james.yoon at utoronto.ca
Wed Jan 6 19:45:31 UTC 2010


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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://fluidproject.org/pipermail/fluid-work/attachments/20100106/fdb82cd7/attachment.html>


More information about the fluid-work mailing list