Details
-
Suggestion
-
Resolution: Done
-
Not Evaluated
-
QSR 2.0
-
None
Description
Some refactoring ideas:
[edit 8.9.2022 Backlog cleaning meeting / Tarja Sundqvist:]
- Create a proper project introduction once, and refer to it from other documents. No need to repeat the same information. For example, the verification plan has now that information repeated. What could be the master document for it? The architecture specification, or project plan, or something else?
- This will streamline the documents
- 8.9.2022 Backlog cleaning meeting: Done, see https://intranet.qt.io/display/QTRD/Qt+Safe+Renderer+Introduction
- Now, some documents have the standard's compliance checklists embedded. (for example, the verification plan has such appendices)
- Consider removing them from the documents, but keep that information elsewhere. Consider creating similar inspection tests in the TestRail for all relevant documents. See for example design documentation inspection checklists
- This will streamline the documents
- This will also make the release note appendix (statement of compliance) obsolete when the information is in the test results for each document.
- Less documentation generated manually.
- 8.9.2022 Backlog cleaning meeting: done, all checklists are now available on Test Rail.
- Consider removing them from the documents, but keep that information elsewhere. Consider creating similar inspection tests in the TestRail for all relevant documents. See for example design documentation inspection checklists
- Now we have two tasks for each document. One for creating a new version and one for collecting the review comments. And we have the design verification page for tracking.
- Maybe one Jira issue per document could be enough in the future? That would reduce the number of tasks.
- 8.9.2022 Backlog cleaning meeting: done, used this practice in QSR 2.0 and it worked well.
- Now the Word documents do not contain the link to the Jira issue containing the review notes and approval information. Maybe that could be considered to be added?
- 8.9.2022 Backlog cleaning meeting: done, in QSR 2.0 the approved comments contains also a related review task id in Jira.
- Now the documents are getting rather long. We have the legacy data dragged in the documents. Should be reset this at some point?
- Like the verification specification document has no obsolete old information.
- For example, the verification plan still has information about the earlier version approvers, the project team etc.
- 8.9.2022 Backlog cleaning meeting: done; in QSR 2.0 the version history contains only 2.0 changes, also the content of the documents has been refactored.