bannerd

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Show If
spacePermissionedit
Panel
titleColorred
titleNote to editors

If this page is used as a template, remove all of the "Note to editors" panels and associated Show-if macros. 

Show If
spacePermissionedit
Panel
titleColorred
titleNote to editors

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

Consult SWE Maintenance Guide for details on SWE Maintenance and how the SWE number is used in References. 

Excerpt

Style guide for SWEs. May be used as a template. 

Tabsetup
01. The Requirement
12. Rationale
23. Guidance
34. Small Projects
45. Resources
56. Lessons Learned
67. Software Assurance
Div
idtabs-1

1. Requirements

Show If
spacePermissionedit
Panel
titleColorred
titleNote to editors

Insert an "Excerpt" macro containing the text, including paragraph number, of the SWE from NPR 7150.2. the excerpt macro should have the "Hide" option left unchecked. 

Excerpt

2.1.1.1 The NASA OCE shall lead and maintain a NASA Software Engineering Initiative to advance software engineering practices.

1.1 Notes

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
spacePermissionedit
Panel
titleColorred
titleNote 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. ensure that the link point to the correct page in SITE space. 

1.3 Applicability Across Classes

Applicable c
a1
b1
csc1
c1
d1
dsc1
e0
f1
g0
h0

Show If
spacePermissionedit
Panel
titleColorred
titleNote 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. 

The data in the Applicability macro must match the "Yes" and "No" information in the SWE from the table in NPR 71500.2 - Appendix C. Requirements Mapping Matrix 

Div
idtabs-2

2. Rationale

Provide a reason for the SWE in this section. 

Div
idtabs-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. 

Div
idtabs-4

4. Small Projects

"No additional guidance is available for small projects."

OR, other statement on applicability of the requirement to small projects.

Div
idtabs-5

5. Resources

Show If
spacePermissionedit
Panel
titleColorred
titleNote to editors

See References in SWEHB for details on using the SWEREFN macro and References in general in SWEHB. The Resources tab in a SWE is configured like this example including the two subheadings below. 

5.1 References

refstable
Show If
groupconfluence-users
Panel
titleColorred
titleVisible to editors only

Enter the necessary modifications to be made in the table below:

SWEREFs to be addedSWEREFS to be deleted


SWEREFs called out in text: 0

SWEREFs NOT called out in text but listed as germane: 1

5.2 Tools


Include Page
Tools Table Statement
Tools Table Statement

Div
idtabs-6

6. Lessons Learned

No lessons learned have currently been identified for this requirement.

OR, statement of lessons learned applicability is needed. 

6.1 NASA Lessons Learned

Lessons that appear in the NASA LLIS or Center Lessons Learned Databases.

  • Lesson Title in bold. Lesson Number 9999:  567  Extract from the lesson. Extract taken which points up the lessons that is appropriate to the SWE or Topic of this page. Add a SWEREF pointing back to the reference for the lesson. 

6.2 Other Lessons Learned (add this category only if appropriate)

Lessons that appear in the sources outside of NASA such as educational sources or industry sources.

  • Lesson Title in bold. Lesson Number 9999:  567 Extract from the lesson. Extract taken which points up the lessons that is appropriate to the SWE or Topic of this page. Add a SWEREF pointing back to the reference for the lesson. 
Div
idtabs-7

This tab is only appropriate for SWEs having SA tasking. It is not used for Institutional Requirements. 

7. Software Assurance

Excerpt Include
SWE-050 - Software Requirements
SWE-050 - Software Requirements
 - gets SWE from tab 1. 

7.1 Tasking for Software Assurance

  1. Tasking for software Assurance goes here. 

7.2 Software Assurance Products

  • The list of SA products goes here


Note
titleObjective Evidence

Evidence is noted here

Expand
titleDefinition of objective evidence

Include Page
Definition of Objective Evidence
Definition of Objective Evidence


7.3 Metrics

  • # of 
  • # of

7.4 Guidance

Software assurance guidance for this SWE goes here.