strictdoc icon indicating copy to clipboard operation
strictdoc copied to clipboard

Document expected baselining/tracing with Git

Open gregshue opened this issue 1 year ago • 0 comments

I'm trying to determine how many Git repositories I need to support scalable requirements management with Strictdoc. Please add a guide describing how the expected/supported way of using StrictDoc with Git to address:

  1. Horizontal Scaling (within each decomposition layer multiple files are introduced with independent edit/baselining cycles);
  2. Vertical Scaling (where new decomposition layers are added to the document tree with independent edit/baselining cycles);
  3. Relationships controlled outside of the statement repository;

For example:

  1. The Stakeholder Needs/Requirements layer describes the scope of the relevant problems. It must always be open to additions to capture needs as they are reported. Baselines must be created for this dynamically changing set so that lower layer documents can be traced to these statements. This baseline must be independent of the lifecycle of the lower layer documents.

  2. The System Requirements layer describes the scope of the (opaque) solution. This must trace back to Stakeholder items. Sometimes this tracing needs to be outside of the repositories providing the Stakeholder and System requirement statements. E.g., System Requirement statements and some User Needs ("As a Product Manufacturer, I need ...") come from a Zephyr Project release. Others come from a release of an open source project from a different organization ("As a Product Manufacturer of a hearing aid, I need ...")). These are integrated into a single product. The tracing must be controlled by the Product Manufacturer in a different repository.

  3. The next decomposition cycle ("element") Requirements layer describes the scope of the (opaque) element. This must trace back to System Requirements and be on a different lifecycle than the system requirements themselves. These also may be an aggregation from multiple sources of requirement statements.

Here are some questions I'd like answers to:

a) How do you recommend Git be used to achieve a baseline for a particular document? b) How do you recommend Git be used to support independent lifecycles for different documents? c) How do you recommend Git be used to provide control and capture of relationships between document layers independent of the requirement statements in each layer?

Please describe in detail how you expect users to apply the following to provide a scalable solution:

  • Git repos
  • Git branches
  • Git tags
  • Git subrepos

gregshue avatar Apr 23 '24 16:04 gregshue