1. Introduction
The Style Guide defines the look and feel of the SWEHB. Many of the styles are used in this guide to demonstrate the use of the macros and styles in the SWEHB. Many of these styles have been use since the original version of the SWEHB. Others are being introduced or implemented starting in SWEHBVD.
2. Tabbed presentation of content
The content of most pages in SWEHB uses the TABSETUP User Macro. This macro serves as a container and organizer of content in a tabbed format.
2.1 Configuring TABSETUP
After inserting the TABSETUP macro, edit the macro and enter the titles for each of the tabs. In SWEHB, tabs are numbered. It is best to keep the tab title short to reduce overflow across the page.
Each tab is implemented using a DIV macro. Each DIV is edited with an ID like "tabs-1", "tabs-2", etc.
The first line in a DIV should be the numbered the same as the tab title. The text style should be "Heading 1". Subsequent subdivisions in the DIV may use styles like "Heading 2", "Heading 3", etc. to organize content.
Further detail in using all macros is included in the various maintenance guides.
2.2 SWE Tab 1. Requirement
Each SWE tab 1 is structured the same.
3. SWE Content
Each SWE tab 1 is structured the same. There is a SWE-000 - SWE Template to aid in the creation of new SWEs. It contains the full structure for a SWE. Also, the SWE formatting is used in the SWE Style Guide and Template.
1. Requirement tab
1. Requirement - contains an EXCERPT macro with the text of the requirement in it. This facilitates reusing the text of the requirement in other SWEHB pages (using the EXCERPT INCLUDE macro)
1.1 Notes - contains the text of the "Notes" for the SWE taken directly from the NPR 7150.2. If there is no Notes section, the text "NPR 7150.2, NASA Software Engineering Requirements, does not include any notes for this requirement."
1.2 History - Contains a link to the History page for the SWE. History pages are located in the SITE space. There is a page for each SWE. On each page is a table with the text of each SWE by NPR 7150.2 version SWE. Between each version of the SWE text is a row describing the differences between the SWEs.
1.3 Applicability Across Classes - contains a table displaying the content of the applicability of the SWE for each of the software classes. It is either Applicable or Not Applicable. Applicability is assigned in an appendix in the NPR 7150.2. Applicability is only included for SWEs that appear in the matrix in the appendix of the NPR 7150.2.
2. Rationale tab
2. Rationale - short statement explaining why the SWE is a requirement. This expands on the requirement and notes from the prior tab.
3. Guidance Tab
3. Guidance - explains how the requirement can be implemented. It may include:
- examples of how to satisfy the requirement
- links to references and other pages containing templates for use in satisfying the requirement
4. Small Projects
4. Small Projects - Guidance on how the requirement can be satisfied by small projects. In some cases, small projects may get a waiver for the requirement.
5. Resources
5. Resources
5.1 References - contains a macro / report of SWEREFS that are called out in the SWE page or
6. Lessons Learned
6. Lessons Learned
6.1 NASA Lessons Learned
6.2 Other Lessons Learned (add this category only if appropriate)
7. Software Assurance
7.1 Tasking for Software Assurance
7.2 Software Assurance Products
Objective Evidence
Evidence is noted here
7.3 Metrics
7.4 Guidance
4. References
References are used throughout the SWEHB. Their structure was designed in the initial 7150 space and continues through all follow-on versions. See the References in SWEHB page for a full description of how references are structured and used in the SWEHB.
5. Quotations
For a complete discussion of Quotations, see the Quotations in SWEHB page.
Quotations have been used in SWEHB since the first version. Quotes vary from short quotes of a few words or phrases, to long quotes of one or more long sentences or paragraphs.