I am working in embedded software domain and my primary work area is development of firmware for various MCUs.
I follow the folder structure as mentioned below for any firmware project to release the source code and docs as complete bundle (.zip archive) for customer use.
Source code contains doxygen commenting. and it contains version number 2.0 (same as zip file). Customer always refer to this version for any discussion.
So, there are two main things that can be changed independently. One is source code and other is documents.
i increment the version number of XYZ-project-2.0.zip to XYZ-project-2.1.zip when
- If source code is changed (i also update the version number in doxygen comments from 2.0 to 2.1)
- Or Any of document version is changed.
- Every time update any document, I change version number of that document (from XYZ-project-software-user-guide-rev1.3.pdf to XYZ-project-software-user-guide-rev1.4.pdf) and update zip file version number (from XYZ-project-2.0.zip to XYZ-project-2.1.zip). but, i also need to update version number inside source code to kept it same (doxygen version comment from 2.0 to 2.1).
So, My Question is,
- Is there any industry standard to co-relate software version and document version. And how should i version final zip file ?
- I still doubt what version tag i should add to any document. doc-Rev1.0.pdf? doc-v1.0.pdf? doc-Rev-A.pdf? Is there any standard ?