bannerd

A. Introduction

B. Institutional Requirements

C. Project Software Requirements

D. Topics

E. Tools, References, and Terms

F. SPAN
(NASA Only)


This checklist is for the new SWEHB page: As each step is completed, note it in the Comments. 

StepDescriptionComments
1Review Requirements Document for the new page and plan for it's creation in the SWEHB
1.1

Determine what type of page it will be: select a new number in the appropriate hierarchy for the new page: 

  • SWE or "Human Rated Requirements in SWEHB"
  • Topic - and subsection (7.xx, 8.xx, ...)
  • PAT - Category
  • Other - Tools, Terms, References, ...

1.2

Add new page in the appropriate place in the hierarchy. See "Space Pagetrees" tab in the SWEHBDOC Maintenance page. Make sure the new name does not conflict with another page. 


1.3

Format the new page to match the layout of other similar pages in the SWEHBDOC Basic Style Guide:

  • SWE pages will have 6 or 7 tabs
  • Topics will have 2 or more tabs
  • PAT pages will be formatted as a PAT
  • Other pages will be formatted based on similar pages

1.4

Apply content provided in the page Requirements Document. Distribute content into tabs as necessary. Follow guidance in SWEHBDOC Basic Style Guide for formatting content. 


1.5

Save the page and verify that the initial content is distributed into tabs as desired. 


2.0

Add SWEHB formatting to the page. This formatting applies to the features and tools available in the SWEHB. This formatting is unique to the SWEHB and gives the page it's unique Look and Feel. SWEHBDOC Basic Style Guide


2.1

Check for the presence of an appropriate "Excerpt-Include" page type


2.2

Check for "Set Data" macro: set to expected tab for Resources


2.3

Check for Show-If and Panel for editors only with Expand for notes to editors


2.4

Setup initial tabbing in Tabsetup macro


2.5

Tag references - 

  • If the reference is in the References Table, Update the SWEREF and add the number to the "SWEREFs called out in text" 
    • If the references is not in the table, add it and add the SWE number into the SWEREF and add the number to the "SWEREFs called out in text"

2.6

Create "Related ..." pages (SWEs, SM, Activities


2.7

Format all tabs

  • Headers
  • Notes

2.8

Proof-read to ensure that content did not get messed up in the copying process. 


2.9

Review content to ensure compliance with SWEHBDOC Consistency of Language

  • life cycle
  • safety-critical
  • non-conformance
  • top-level
  • flow down
  • Software Assurance Plan, SA Plan
  • NPR 2810.1 Security of Information and Information Systems
  • NIST SP 800-40  Guide to Enterprise Patch Management Planning: Preventive Maintenance for Technology
  • IEEE Standard Dictionary of Measures of the Software Aspects of Dependability, 8 November 2005

PAT -1

Build checklist based on similar PAT


P.1

Build checklist


P.2

Content 


P.3

Save as a PAT


3.0

Publish to SWEHB


3.1

Add to appropriate Top Level Page


3.2

Build Blog entry and label "swehb" - ensure that it displays on Book A. Introduction page



  • No labels
Page Editor: Tim Crumbley
NASA Official: Tim Crumbley
Accessibility
NASA Software Engineering Handbook - A service of the NASA Office of the Chief Engineer
NASA Privacy Statement
______________________________________________________________________________