Documentation Version Numbers

29 Jan 2007 - 3:19pm
7 years ago
2 replies
691 reads
Dante Murphy
2006

I'm trying to establish a documentation numbering standard for my team,
and there is some initial resistance to the approach I've used for
years. I'm wondering what approach you all use, or what your opinions
are on the merits and drawbacks of these two approaches.

Approach A: Every revision of a document is given a new integer-value
version number. For instance, Site Map v6 is updated and becomes Site
Map v7.

Approach B: Every version of a document made during the "Define" phase
of a project is numbered 0.x. For example, Site Map v0.3 is revised;
some new pages are added, some deleted, and some changes to the site
hierarchy are made. The new version is Site Map 0.4. Some additional
changes are made, but they are very minor...a spelling correction or a
label change on some elements, but no change to scope or functionality.
The new version is Site Map v0.4.1.

Once a project is well defined, the project enters "Design" phase and a
baseline version 1.0 is published. From this point forward a detailed
revision history is kept. The same numbering guidelines apply as in the
"Define" phase.

Once the design is approved and the project enters the "Build" phase,
the design document is again baselined at version 2.0. Any revisions to
version 2.0 (or higher) should be managed through a change order.

Looking forward to your feedback.

Dante

_______________________________________

Dante Murphy | Director of Information Architecture

Medical Broadcasting Company | A D I G I T A S INC. COMPANY

Comments

29 Jan 2007 - 3:59pm
Lana Carlene
2007

I haven't used either of those approaches, although they make sense.
Your "Approach A" seems to be easiest, just looking at the level of
instruction needed to follow it! :-) What part is your team resisting
(or do they just like their own, established methods)? One of my
concerns has always been to make it easy on myself to organize and track
files on my computer/server.

I've kept site maps & wireframes together in a "V1" folder, and each
wireframe has its own reference number, which maps to the site map.
After a team/client meeting where changes are decided upon, a new copy
of the folder becomes "V2" and everything is together (even if all docs
don't have changes) -- rather than using a V6 sitemap with V2 home page
and V3 shopping cart, etc.

So for example, I have a "master" site map, then a numbered hierarchy of
pages:
1.0 Home Page
2.0 Account Page
2.1 Account Registration Page
2.1a Account Registration Pop-Up Dialog(s)
2.2 Account Preferences Page
3.0 Product Page
Etc...

I've found that this system helps when referencing pages in meetings.
The end doc is easy to access and in some cases I've created a PDF doc
with a clickable site map that jumps directly to the corresponding
wireframe page.

When it actually goes to build, then the whole thing becomes "V1.0" in
the more traditional software-release sense.
_____________________
Lana Carlene | Metia

-----Original Message-----
From: Dante Murphy

I'm trying to establish a documentation numbering standard for my team,
and there is some initial resistance to the approach I've used for
years. I'm wondering what approach you all use, or what your opinions
are on the merits and drawbacks of these two approaches.

29 Jan 2007 - 4:35pm
mprove
2004

Hi Dante,

this little article seems to address your question (from my point of view):
http://www.mprove.de/script/06/uxf/newsletter13.html

Note the discussion at
https://www.xing.com/cgi-bin/forum.fpl?op=showarticles&id=1124675

cheers,
Matthias

--

User Experience and Interaction Design :: http://www.mprove.de

Syndicate content Get the feed