If this page is used as a template, remove all of the "Note to editors" panels and associated Show-if macros.
Show If
spacePermission
edit
Maintenance guide for SWEs
Panel
titleColor
red
title
Note to editors
1. SWE
The SWE is shorthand for "Software Engineering Requirement". It is used throughout the SWEHB.
1.1 Structure of a SWE title
The title of the SWE has two parts. For Example: SWE-987 This Is the Title
The SWE number is 7 characters and the numeric portion is always a 3 digit number. This is necessary for the referencing to work properly. See References in SWEHB for details.
The title portion is a text headline for the SWE telling the viewer what the SWE is all about
Consulte
Excerpt
.
Tabsetup
0
1. The SWE
1
2. Adding SWEs
2
3. Retiring SWEs
3
4. Reserving SWEs
Div
id
tabs-1
1. SWE
The SWE is shorthand for "Software Engineering Requirement". It is used throughout the SWEHB.
1.
1 Structure of a SWE title
The Notes from the SWE in NPR7150.2 are copied here. In "paragraph" style with bullets as necessary. If there are no Notes, the statement below is the only note in this section.
NPR 7150.
2
, NASA Software Engineering Requirements, does not include any notes for this requirement.
1.2 History
Click here to view the history of this requirement: SWE-050 History
Show If
spacePermission
edit
Panel
titleColor
red
title
Note to editors
The SWE history page is in the SITE Resources space. It is either under the "SWEs Retired" or "SWEs in current use" pages.
1.3 Applicability Across Classes
Applicable c
a
1
b
1
csc
1
c
1
d
1
dsc
1
e
0
f
1
g
0
h
0
Show If
spacePermission
edit
Panel
titleColor
red
title
Note to editors
The "Applicability Across Classes" section contains only the appropriate Applicability macro. See User Macros in SWEHB for details on using the Applicability macro.
Div
id
tabs-2
2.
Rationale
Provide a reason for the SWE in this section.
Adding SWEs
2.1 Reusing SWE Numbers
The SWE number comes from the NPR. The number is assigned there. The SWEHB Maintainer must work with the NPR authors to ensure that numbering of SWEs is performed properly.
Care should be taken when adding SWEs to not create duplicate SWE numbers. Also, if a SWE has been added and published in a SWEHB version, the topic for that SWE number is established. SWEs may be reused if the content of the SWE has not changed much. However, if it is very different, consider using a new SWE number. There is a very simple reason for this. When a new version of the SWEHB is created, a full copy of the latest version of the SWEHB is used as a model for the new version. All the SWEs from the old version are duplicated in the new version. All references to a SWE are reused. If a SWE number is reused with a total different title, there will be confusion created among the references for the SWE because the first 7 characters of the SWE title are used for tying a reference to a SWE.
2.2 Creating a new SWE Page
In the directory tree for a SWEHB version space there is a page for "SWE Pages". This is the container for all active SWEs in the version. In the Protected Area, there is another container for "Retired SWEs". All possible SWEs, used or reserved so far, are found in one of these containers. If you are creating a new SWE page, start by opening, in a new tab, a page from the SWE Pages container.
Use the "Copy" comment on an that existing page to create a new page from the old page. This works best if the existing page and new SWE are similar in structure. Specifically, "Institutional Requirements" from chapter 2 in NPR 7150.2 have fewer tabs than Project Software Requirements" in chapters 3 through 5 of NPR 7150.2.
Retitle the new page by removing the "Copy of" from the title, changing the SWE number, and replacing the title with the new title of the page.
At this point, Save the new page.
Verify that the new page appears in the page tree for the space, in the SWE Pages container. If there is a problem with the page title, fix it before moving on.
Next, open the page for editing and cleanout the old content, saving structure for reuse in the new SWE:
You will reuse the TABSETUP structure including tab titles, and heading structures.
In 1. Requirements, copy from NPR 7150.2 the paragraph number and SWE text into the Excerpt macro.
In 1.1 Notes, copy from NPR 7150.2 the Notes for the SWE
In 1.2 History, replace the link to the SWE History page with a new link to a new page for this SWE. See SWE History Maintenance for details.
Div
id
tabs-3
3. Retiring SWEs
P.
Div
id
tabs-3
3. Guidance
Provide additional guidance for the SWE in this section.
Use numbering and bullets as necessary.
Graphics may be used also to explain concepts. A copy of the original artwork should be attached to the page so it can be used if the image needs to be revised.
3.1 Additional sub headings
Use Heading 1 style for the initial heading in the tab. Use Heading 2 style for the next level of subheadings. If a lower heading style is needed, use Heading 3. Try to not have lower heading styles below 3.
If a summary of referenced SWEs is appropriate, use a simple table of links like the one below.
