Naming convention for wiki/svn/etc...

Leah Maestri leahm at sfu.ca
Thu Jan 14 18:23:05 UTC 2010


+1

Thanks Jess.
Lee


----- Original Message -----
From: "Jess Mitchell" <jess at jessmitchell.com>
To: "Leah Maestri" <leahm at sfu.ca>, "fluid-work" <fluid-work at fluidproject.org>
Sent: Thursday, January 14, 2010 8:31:09 AM GMT -08:00 US/Canada Pacific
Subject: Re: Naming convention for wiki/svn/etc...

Hey y'all,

Folks are using the Proposal 2 from this wiki page: http://wiki.fluidproject.org/display/fluid/Designer+Naming+Convention

I recommend we formalize and hereby call it the Designer's naming convention.  Have a look in the wiki where I've indicated what we're using and then let your opinion be known...

Best,
Jess


~~~~~~~~~~~~~~~~~~~~~~
Jess Mitchell
Boston, MA, USA
Project Manager / Fluid Project
jess at jessmitchell.com
/ w / 617.326.7753  / c / 919.599.5378
jabber: jessmitchell at gmail.com
http://www.fluidproject.org
~~~~~~~~~~~~~~~~~~~~~~




On Jan 7, 2010, at 12:21 PM, Leah Maestri wrote:

> Will do!
> 
> Lee
> 
> ----- Original Message -----
> From: "Jess Mitchell" <jess at jessmitchell.com>
> To: "James William Yoon" <james.yoon at utoronto.ca>
> Cc: "Leah Maestri" <leahm at sfu.ca>, "fluid-work" <fluid-work at fluidproject.org>, "Victoria Moulder" <victoria_moulder at sfu.ca>
> Sent: Thursday, January 7, 2010 6:55:46 AM GMT -08:00 US/Canada Pacific
> Subject: Re: Naming convention for wiki/svn/etc...
> 
> Yes, let's throw this into the wiki on the new pages that Vicki created.  James, can you take on vocab and Lee can you take on naming convention -- document and explain.  Then let's point to those wiki pages and have another +/- vote onlist.
> 
> Thanks for all your work on this y'all!
> 
> Best,
> Jess
> 
> ~~~~~~~~~~~~~~~~~~~~~~
> Jess Mitchell
> Boston, MA, USA
> Project Manager / Fluid Project
> jess at jessmitchell.com
> / w / 617.326.7753  / c / 919.599.5378
> jabber: jessmitchell at gmail.com
> http://www.fluidproject.org
> ~~~~~~~~~~~~~~~~~~~~~~
> 
> 
> 
> 
> On Jan 6, 2010, at 3:08 PM, James William Yoon wrote:
> 
>> Also, on a related topic:
>> 
>> We've been confusingly using the following words interchangeably within the design space for some time now: iteration, draft, version, revision. In fact, in the wiki, we used all three of iteration, draft, and version to indicate a design cycle in different places (in mobile we used "draft", in the kiosk wiki titles we used "iteration", and in the kiosk filenames we used "version").
>> 
>> My suggestion would be to standardized across the board and use the following definitions.
>> 
>> ITERATION:
>> Our two-week design planning iterations (e.g., the current iteration, iteration 13, is from January 5-19).
>> 
>> DRAFT:
>> One cycle of design (e.g., we recently finished draft 4 of our kiosk wireframes/design, and draft 8 of our mobile wireframes).
>> 
>> VERSION:
>> The production release of the product (e.g., Engage version 0.3 will be released at the end of next month).
>> 
>> REVISION:
>> The file revision number used by svn (e.g., 8905 is the latest revision of file x in the repository). This is rarely referred to.
>> 
>> Thoughts?
>> 
>> Cheers,
>> James
>> 
>> On Wed, Jan 6, 2010 at 2:45 PM, James William Yoon <james.yoon at utoronto.ca> wrote:
>> 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
>> 
>> 
> 
> _______________________________________________________
> fluid-work mailing list - fluid-work at fluidproject.org
> To unsubscribe, change settings or access archives,
> see http://fluidproject.org/mailman/listinfo/fluid-work




More information about the fluid-work mailing list