openETCS / governance

part of WP1: information needed to run project management in openetcs
7 stars 13 forks source link

PL-VETO: ReviewProcessˆ P5L13: "The review document: In Tex format with all its history of changes": NO ! #16

Closed KlausRuedigerHase closed 11 years ago

KlausRuedigerHase commented 11 years ago

This is a VETO by the project leader. Processes and Documents should be as slim as possible in order to make it an easy to handle quality process. One of the major advantages for doing version control in Git on GitHub is the fact that Git automatically keeps record on all previous versions and changes made on the document. Therefore it is not useful to keep this record on two places: Inside the document itself and inside the GitHub repository. (Double data storage is always to avoid because it almost always causes inconsistencies). Therefore the document should be cleaned up in a way that only the actual valid information should be in the the TeX file as well as the PDF representation. It is a matter of “document hygiene” in the same way we practice “software hygiene” by avoiding “dead code” inside the source code file, which is even not permitted for high assurance software anyway. So we do not want “dead text” in the software. All record keeping has to be done by Git and GitHub which provides secured traceability in a much higher quality. I consider that “feature” as a failure.

That part needs to be rephrased: ReviewProcessˆ P5L13:

"The review document: In Tex format has to be a one-to-one representation of the PDF file (no “dead text”, no “history of changes”)

Therefore it is important to make the issue tracker the main tool in the review process, because only with the issue tracker the various opinions of the reviewers can be trace and tracked. You cannot do that inside the document, because then the size of the document would explode and the document becomes completely un-maintanable. BTW: P5L13 means Page 5 Line 13

agracia commented 11 years ago

This part has been deleted from the current 'Revision document'. There shall not be history of changes, so they shall be controlled exclusively through the GitHub