Astrojays Rocketry – Specifications

Docs: Specification Guidelines

Mon, 01 Jan 0001 00:00:00 +0000

Version: 0.0.1
Date: 29 September 2019
Status: Draft
Type: Meta-Specification
ID: 0M

Description

All specifications must have the following components:

Title
Header
Description or Overview section
Requirements section

and may also contain a “Components” and “Implementation” section as deemed necessary. Specifications must be written in markdown or asciidoc syntax, to ensure that the plaintext is equally readable.

Title and Header

The title should be a concise description of what the specification covers. All titles for specifications must be unique to prevent confusion.

The header serves as the “metadata” for the specification and should only contain the following fields:

Version: Following semver specifications
Date: Indicating the date that the specification was last updated
Status: Indicating where the specification lies along the specification lifecycle
Type: Describing what type of document it is. Must be one of the following values:
1. “Specification”: Engineering specifications for systems, formats, and components
2. “Meta-Specification”: Specifications about specifications are specification lifecycle and usage.
ID: A unique number assigned to each spec when it reaches draft status that serves as an official alias.

When creating the header, each line should have two space characters ( ) to force a new line between each item.

Example title and header

# B System Specifications
Version: 0.1.1  
Date: 20 September 2019  
Status: Draft  
Type: Meta-Specification

Overview/Description

This section shall contain a short description of the thing covered by the specification, as well as a brief overview specification conditions.

Requirements

This section shall list each requirement of an implementation that is in spec Each item listed here must be verified before the system is declared complete. Definitions written here shall follow meta-spec 1M “Keywords for use in specifications”

Docs: Specification Keywords

Mon, 01 Jan 0001 00:00:00 +0000

Version 1.0.0
Date: 29 September 2019
Status: Current
Type: Meta Specification
ID: 1M based on rfc2119

The following keywords shall carry special meaning when used within a specification:

SHALL: This word, and the words “REQUIRED” and “MUST”, mean that the definition is an absolute requirement of the specification. Implementations that fail to comply with one of these directives are always out of spec
SHALL NOT: This phrase and the phrase “MUST NOT” mean an absolute prohibition of the specification.
SHOULD: This word, or the word “RECOMMENDED”, mean that the definition is a strong recommendation of the specification that should be followed in the absence of a valid reason to diverge. Team members should seek advice from the subsystem lead before disregarding these directives. Divergences with documented justifications are within spec.
SHOULD NOT: This phrase means a strong discouragement of the specification.
MAY: This word means that the definition is completely optional recommendation of the specification and may be disregarded at will. Divergences are always within spec.
MAY NOT: This words means that the directive is a completely optional prohibition of the specification.

Docs: Specification Template

Mon, 01 Jan 0001 00:00:00 +0000

Version: 0.1.0
Date: 29 September 2019
Status: Provisional Document
Type: Meta Specification
ID: 2M

Template

Copy and paste the following into a markdown file, edit out the placeholders, and remove unneeded portions.

# Specifications for [system]
Version: [version]  
Date: [Date]  
Status: [status]  
Type: System Specification  
ID: [ID]  

## Overview
[Required Section]
This *word* is italicized. This **word** is bold.

## Goals
[Optional Section]

## Requirements
[Required Section]
1. This
2. is
3. an
4. ordered
5. list.

## Out of scope
[Optional Section]
- This
- is
- an
- unordered
- list.

## Componenets
[Optional Section]
```
this is a prmformatted code block
syntax highlighting will be automatically applied.
```

## Implementation
[Optional section]

## See also
[Optional section]

Docs: Specifications for Propulsion Avionics

Mon, 01 Jan 0001 00:00:00 +0000

PLACEHOLDER