1. Introduction

The Features and Tools pages contain detailed instructions on implementing the features and using the tools associated with the SWEHB. 

The content of Features and Tools includes: 

2. Look And Feel Of SWEHB

The Look and Feel of the SWEHB is implemented in two ways. The page Header / Footer, and the page layout implemented with the tab structure. 

2.1.1 Header and Footer

At the top of each page is the Header. This area contains several elements that help the SWEHB user to navigate through the handbook. 

• Link to  "Return to Software Engineering Community of Practice" is helpful to users that got to the SWEHB from the NEN. 
• SWEHB Graphic - this is also a link back to the Introduction page (home page for the SWEHB)
• Navigation buttons - This take the user to the main Top Level Pages in the SWEHB. The SPAN button takes the user to NEN where the SPAN application is available. 
• Search is a Confluence app that allows the user to perform a key word search for any string in the SWEHB. 

At the bottom of each page is a set of links to the NASA Privacy Statement and email links to the Curator of the SWEHB. 

See "SWEHBDOC Refined Theme" for details on how the header and footer are administered using the Refined Theme Plugin. 

2.1.2 Page Layout

Each page that users see is structured in a tabular format. The tabs are built using the "tabsetup" User Macro. See "SWEHBDOC tabsetup" for details. 

All SWE pages are constructed with the same set of tabs. Topic pages may have a different tab structure but will always have a "Resources" tab. 

3. Top Level Pages

3.1 High Level Structure - Buttons in Header

The structure discussed here is the logical structure. The logical structure is mimicked by the pagetree which has a few obvious differences to facilitate maintenance of a version.  

The structure of the SWEHB (links are to pages in SWEHBVD for reference) is: 

• A series of Top Level Pages which organized as quick access buttons visible in the SWEHB Header:
  • Introduction - Book A. Introduction - Introductory material regarding the NPR. the SA Standard, and navigation links to other versions of the SWEHB. 
  • Requirements - two collections of Requirements -
    • B. Institutional Requirements 
    • C. Project Software Requirements 
  • Topics - D. Topics - Supplementary materials to provide additional guidance beyond that contained in the requirement pages. 
  • Tools, References and Terms - E. Tools, References, and Terms - Additional pages of materials derived from the NPR, and other relevant documents. 
  • Link to SPAN in NEN
• Each Top Level Page has a collection of child pages 
  • SWE Pages - each requirement has a page with material specific to the requirement. All requirements pages are formatted the same for consistency. 
  • Topics Pages  - each topic has a page with material specific to the topic. All topic pages are formatted in a similar manner but due to the nature of the topic, the tabs may differ. Each topic has a Resources tab for consistency. 
• Administrative pages - are included in the pagetree but are not directly visible in the page SWEHB header. 
  • Admin pages - contains pages for maintenance use (like Healthcheck) and other utility pages that may get pulled into a page using the Include Page macro (like New in SWEHB). 
  • DEMO AREA - a place for storing pages in development
  • Protected Area - a place for storing pages that users should not have access to but are necessary for maintenance. 
  • References Table  - a report containing References Table.  

3. Top Level Pages

3.1 Page Top Messages

3.2 Book A. Introduction

3.3 Requirements

3.4 D. Topics

3.5 E. Tools, Refs, Terms

3.6 Other Admin Pages

3.6.1 - FAQ

3.6.2 - PAT

3.6.3 - Activity

4. Requirement Page Style

4. SWE Page Layout

4.1 Tab Structure

Req, Rationale. Guidance, Resources, ...

4.2 Human Rated Requirements

5. Topic Page Style

5. Topic page Layout

5.1 Tab Structure

6. PAT Page Style

7. Activity Page Style