The role of the document number and the document version number

1. Document numbering
  
   Software development is inseparable from the preparation and review of design documents. Every stage of development produces a lot of documentation. Usually documentation is shared within the team via svn. When the number of documents in a stage exceeds 50, finding a document in a directory is a pain. It is often the case that the names of the documents are long and similar, which makes it time-consuming to find the required documents.

   Here's an easy fix. Assign a two-digit number to each document, and each document must begin with the document number. For example:
   00.xxx Functional Requirements Analysis and Design.doc

   If you want to see a document submitted by someone, you only need to know the number of the document he submitted.
  
   Personally, I think two document numbers are good, and the lengthy document numbers with many meanings are useless.


2. Document version number
  
   Writing a document will inevitably require multiple revisions. Once the document has been sent to others, when the revised document is submitted again, how to inform the relevant person that the content of the document has changed?
   The method is simple, assign a version number to the document and end the document with the version number. For example:
   00.xxx functional requirements analysis and design_v1.0.doc
 
   When the document is revised and released again, the suffix version number will be modified, for example:
   00.xxx functional requirements analysis and design_v1.1.doc

   This is the case, get a new document readers will not be confused with the previously obtained documentation. You can also easily know the old and new documents in your hand by communicating the version number.

  

Guess you like

Origin http://43.154.161.224:23101/article/api/json?id=326074113&siteId=291194637