OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

saf message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Documents naming and maintenance


Hi all,

A few rules and guidelines on naming and versioning:

Stages in TC documents: 
Working Draft -> Committee Draft -> Public Review Draft -> Committee Specification -> OASIS Standard

All of the above have both Versions AND Revision numbers EXCEPT the Working Drafts which have no Revisions (all changes are reflected in an updated Version number).

So, here are the rules for naming and versioning:

For Working Drafts we use the suffix "WD" at the end of the filename, and when changes are made, we REPLACE the file NOT add a new one to the folder! This will keep track of the revisions for the WD.

When a WD is approved, only then we create a new document with the suffix "CD 01". Every time changes are made, we REPLACE the file, thus increasing its revision number. When a new version of the CD is approved, we create a new document with a new suffix "CD 02" and so on.

Same process for Public Review Drafts and Specifications.

On top of that, we will also use the following prefixes, as discussed previously:

"SAF-" for specification or profile related documents (e.g. Spec it self, Whitepaper and Issues list)

"Educational-" for promotional documents (e.g. FAQ & PPT.)

"UseCase-" for use case documents

Some examples:

"SAF-WhitePaper WD" -no version reflected in the name itself. Instead, it is tracked everytime we replace the file (like SVN sort of)
"SAF-WhitePaper CD 01" -only Version but no Revision reflected in the name itself! Revisions are tracked when we replace the file.
"UseCase-Provisioning WD"
"Educational-FAQ WD" -the current name for the unapproved FAQ.
"Educational-FAQ CD 01" -when we approve the FAQ it will get this name


If you are in doubt please contact me or send me or Jeff the file to upload properly.

As I'm currently trying to "clean" the documents folder based on the rules above, expect to receive action items to clean up some of the files uploaded (due to permission restrictions even for us chairs!)

Sorry for the long email and thanks for the understanding and cooperation!

Cheers,

Stavros


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]