140 likes | 266 Views
Consistent version numbering across drafts & deliverable. Laurent VRECK, ETSI Standardization Projects laurent.vreck@etsi.org. Reasons (1). Most ETSI deliverables are being revised several times
E N D
Consistent version numbering across drafts & deliverable Laurent VRECK,ETSI Standardization Projectslaurent.vreck@etsi.org
Reasons (1) Most ETSI deliverables are being revised several times Delegates often don’t refer to a document by its WI number but either by its ETSI number, or just by elements of its title. hence the need for a coherent version numbering across multiple revisions of deliverables and their drafts.
Reasons (2) THIS: 0097-3v251_FinalVersionCleaned_LaurentCommentsAdded_RevisedNSNOK_ ReadyFor2ndApproval.doc Never again… ;-)
Keeping consistent versioning across drafts & deliverable Version nb • Goal: • Agree on clear and simple common practice • Improve & unify Drafts & Deliverables version numbers • Ultimate goal: • Provide easy and quick access to reliable and accurate project data. • make information retrieval easier
Terminology Draft : a working document, not yet publishedDeliverable: a published ETSI document Basic Rules • Each time a document(*) is modified its version is incremented(even if only a comma is changed in the text) v0.0.4 + ";" = v0.0.5 • Version numbers NEVER go backwards • The version number identifies the current version of the present document(*), it does NOT identify a foreseen future publication version. (*): document = draft OR deliverable
Vm.t.e mincremented for a major new versiontincremented for new version with technical changes eincremented for new version with editorial changes Terminology Draft : a working document, not yet publishedDeliverable: a published ETSI document Draft & deliverable versioning Use of the 3-digits version number
? Prefered practice : reset least significant digit(s) when incrementing more significant digit. Exotic practice :Increment digits without reseting least significant ones.to be avoided PUB . . . . . . . . . PUB Terminology Draft : a working document, not yet publishedDeliverable: a published ETSI document Consistent versioning …Avoid exotic practices v0.0.1 v0.0.1 v0.0.2 v0.0.2 v0.1.2 v0.0.3 v0.1.3 v0.1.0 v0.1.1 v0.1.14 v0.1.2 v0.2.14 v0.2.0 v0.2.15 v0.7.21 v0.7.4 v1.7.21 v1.0.0
v1.1.1 New WI PUB . . . . . . . . . Terminology Draft : a working document, not yet publishedDeliverable: a published ETSI document Consistent versioning …Version numbers NEVER go backwards YES NO v0.3.0 v0.3.0 v0.3.0 New WI v0.3.1 v0.3.1 v0.3.2 v0.3.2 v0.4.0 v0.4.0 v0.4.1 ES 201 873-6 v1.1.1 v0.4.1 PUB PUB v1.1.2 v0.4.2 v1.2.0 v0.5.0 v1.3.0 v0.6.0 ES 201 873-6 v2.1.1 PUB Draft and deliverable versions belong to the same sequence
New WI New WI New WI . . . Consistent versioning …Accross editions PUBLICATION DRAFT First edition v0.2.0 v0.3.0 v0.3.1 v0.3.2 v0.4.0 (D) TS 183 004v1.1.1 v0.4.1 PUB Second edition v1.1.2 New major version v1.2.0 (R) TS 183 004v2.1.1 v1.3.0 PUB Third edition Not a new major version,but technical changes v2.1.2 v2.2.0 (R) TS 183 004v2.3.0 v2.3.0 PUB
History Box Information filled in by the rapporteur at the last page of a draft document :
Revision Marks Useful word processor feature allowing to keep track of changes made by one or more users over time.
‘Reviewing’ toolbar Turning ‘rev-marks’ ON
Drafts Location • Between meetings • Drafts must be uploaded in the «70-Draft » area of the server • Discussions take place on the TB mailing list • Before meetings • Last version should be made available as a meeting document.If it is for approval during the meeting it MUST be made available as a meeting document. • Contributions against drafts are submitted as meeting documents and discussed during the meeting