11. CrosslinkingAll pages in the SWEHB are reviewed and have links pointing to Related SWEs and Supplementary Materials which are listed in the Guidance tabs or Resources tabs. This cross-referencing extends to Activities and provides Bi-directional traceability among the Activities, Requirements, and Supplementary Materials. See the Crosslinking Tab for more details. 11.1 General Crosslinking The concept of Crosslinking comes from the application of Bi-directional Traceability. A requirement from NPR 7150.2 is a simple statement of something that must be done in a Software Development Project. When it is enhanced in the Handbook, information is added such as - Rationale - Why the requirement should be done i.e. what is the value to the project of performing the requirement.
- Guidance - How to satisfy the requirement. This can include multiple ways to satisfy it, some of which might be complex.
- Small Projects - Discussion on alternatives for how small projects might satisfy the requirement.
- Resources - References and other helpful information about the requirement.
- Lessons Learned - Information about problems that have occurred or were avoided by satisfying the requirement.
- Software Assurance Guidance - How SA supports and assists in the satisfying of the requirement.
It is up to the author to identify the crosslinking that is appropriate on a page. This is based on the content. For example, in a SWE page Guidance tab there may be a statement about how a Topic provides a technique that can be used to satisfy the requirement. A link to the Topic page would be included in the text of the tab. It would be appropriate to also have a link in the Topic that points back to the SWE acknowledging that the topic can be used to satisfy the requirement. Additionally, Since all SWEs are a part of one or more Activities, it would be appropriate for the SWE to point to the appropriate Activity. From the point of view of the Activity, the Activity should include the SWE in its list of related SWEs and the Topic in its list of Related SM (Supplementary Materials). To support this concept, each SWE, and Topic has several child pages. For example, SWE-020 - Software Classification would have the following children: 11.2 Page InformationBy reviewing the "Page Information" for a page it is possible to see the incoming and outgoing links for the page this will tell you: - Incoming Links - Other pages that are pointing to the page as s target. This is where other pages will send the user to the page.
- Outgoing Links - Links to other pages that the page is sending users to.
- Parent Page - the parent of the current page in the hierarchy
Each of the incoming and outgoing links should appear in one of the "Related" pages to be properly crosslinked. 11.3 Crosslinking in SWEsA SWE page may have links to the following crosslinked pages: - Another SWE page that is in the same phase, in a preceding phase, or a succeeding phase.
- SM page that is somehow related to the subject of the SWE or its guidance.
- Activity where the SWE may be performed.
11.3 Crosslinking in Supplementary Materials A Topic or SM page may have links to the following crosslinked pages: - SWE pages that are in the same phase, in a preceding phase, or a succeeding phase.
- SM page that is somehow related to the subject of the Topic or its guidance.
- Activity where the Topic may be used.
11.4 Crosslinking in ActivitiesAn Activity page may have links to the following crosslinked pages: - SWE pages that are in the same phase, in a preceding phase, or a succeeding phase.
- SM page that is somehow related to the subject of the SWE or its guidance.
11.5 Additional Guidance SectionsIn each SWE there is an "Additional Guidance" section in tab 3 (and tab 7). This section contains a Related Links table with Include-page macros pulling in the "Related SWEs" and "Related SM" child pages. In each Topic there is an "Additional Guidance" section in the Resources tab. This section contains a Related Links table with Include-page macros pulling in the "Related SWEs" and "Related SM" child pages. Here is an example of a "Related Links: table from a SWE.
|