[INSTRM-796] SM1 test docs: Assign new document codes and reorganize Created: 21/Oct/19  Updated: 22/Oct/19  Resolved: 22/Oct/19

Status: Done
Project: Instrument control development
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Normal
Reporter: hassan Assignee: hassan
Resolution: Done Votes: 0
Labels: SM1, SPS
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to INSTRM-769 Update SPS-SW-TestCases document Done
relates to INSTRM-795 Generate SM1 SW-TestReport Done
Story Points: 1
Reviewers: yuki.moritani

 Description   

Following discussions with Project Office, it has been agreed that the SM1 test documentation should have new document codes, given that the majority contributor for those documents, arnaud.lefur, is based at LAM.

The document titles should also be adjusted where appropriate.

The new document codes and titles will be:

  • PFS-SPS-LAMPRC1072 : SpS Software Test Cases
  • PFS-SPS-LAMTRE1073 : SM1 Pre-ship Software Test Report

The previous document codes, PFS-SPS-PRU030005 and PFS-SPS-PRU0006 respectively, that were assigned to version 1.0 of each of those documents, will no longer be used. A note will be added to the contents both documents to mention that.

Future releases of the TestCases document, for different SpS test campaigns, will be in the form of new versions of PFS-SPS-LAMPRC1072, as these will be evolutions of the same document. Future test reports, on the other hand, capture the result of separate test campaigns so thus will have separate document codes.

The document tree under the GitHub ics_doc repo will also be reoganized. The current proposal is as follows:

ics_doc:
    - SPS
       - TestCases
          - v1
          - v2
          - <etc>
       - TestReports
         - PFS-SPS-LAMTRE1073
         - <NextReport>


 Comments   
Comment by hassan [ 22/Oct/19 ]

The eventual structure implemented and approved by Project Office is as shown below. The v1 and v2 subdirectories are replaced with one single subdirectory corresponding to the evolving test cases document, as intermediate changes of that document are tracked through git and concrete issued documents will be placed under PBworks.

ics_doc:
    - SPS
       - TestCases
          - PFS-SPS-LAMPRC1072
       - TestReports
         - PFS-SPS-LAMTRE1073
         - <NextReport>
Generated at Sat Feb 10 16:28:44 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.