2. DefinitionsIn the context of this view of the SWEHB, some definitions are in order. These are ideas for helping partition the information so it can be organized in a way to make finding things easier. 2.1 ActivityGeneral name for a set of processes, performed by one or more groups of stakeholders in the lifecycle of the development of a software product. Activity names may align with project phases in some cases depending on the development process or life cycle chosen for the project. Some activities are performed in a sequence. Others may be started and continue while others start up later and run in parallel with other activities. An example of this is coding and testing. These activities may appear to run together while different portions or releases of the code are being developed. An activity is composed of - SWE requirements that are satisfied during the conducting of the activity, and
- Other work described in the other SWEHB components.
2.2 SWE ComponentsEach SWE requirement is composed of one or more objectives that represent an industry best practice that OCE expects projects (on the agency in the case of Institutional Requirements) to perform. How these objectives are achieved is at the discretion of the group satisfying the requirement. Each SWE page lists some tasks that would accomplish the requirement, and guidance on how they might be completed. Tasks for the Software Engineering (tab ?) as well as Software Assurance (tab 7) are listed. In cases where additional support or more in depth guidance is available, the reader is referred to a Topic. 2.3 Other SWEHB ComponentsAny page in the SWEHB that contains guidance on performing a process, creating a document, implementing a development tool, preparing for or conducting a review, or other related topic supporting the work of an activity. The Topics page could be expanded to organize and present more groupings of topics. Numbering of topics allows existing reference macros to be used in the Resources tab of the topic. Components include: | Component Type | Topic Series | Component Description |
|---|
| Document Content | 5.xx | Describes the minimum content expected in a particular document | | Checklist | 6.xx | List of things to consider when performing some development or assurance task in a project. Checklists are frequently designed as a Process Asset Template (PAT). | | PAT (Process Asset Template) | PAT-xxx | List of things to do or consider when performing a development or assurance task in a project. These may be used in any of the other Topic series | | Review | 4.xx | List of things to do or consider when performing a development or assurance task in a project. Usually includes Items for: - Preparing for the review
- Actions taken during the review
- Actions taken after the review
| | Process |
| Regularly performed set of actions with an expected set of outcomes. Usually contains: - Triggers that cause the process to be initiated
- Inputs
- Process Steps which may be performed in a sequence or simultaneously
- Outputs
- Follow up actions to account for defects that need to be fixed
| | Software Engineering Topics | 7.xx | In depth guidance on Software Engineering topics. | | Software Assurance Topics | 8.xx | In depth guidance on Software Assurance topics. | | Software Safety Topics | 3.xx | In depth guidance on Software Safety topics. | | Software Design Principles | 9.xx | Software Design Principles. | | Cybersecurity Topics | 2.xx | In depth guidance on Software Cybersecurity topics. |
|