Skip to content

GitLab

digitec spec process · Changes

Page history
rcabral created page: digitec-spec-process authored by Rene Cabral's avatar Rene Cabral
Hide whitespace changes
Inline Side-by-side
digitec-spec-process.markdown
View page @ c276e69c
...@@ -5,9 +5,15 @@ ...@@ -5,9 +5,15 @@
The first step you must take as a developer BEFORE starting any project, job, or task, and BEFORE writing down any code, is to correctly identify the requirements that need to be fulfilled in order to satisfy the project, job, or task. The first step you must take as a developer BEFORE starting any project, job, or task, and BEFORE writing down any code, is to correctly identify the requirements that need to be fulfilled in order to satisfy the project, job, or task.
### The Guidelines: ### The Guidelines:
For large projects we use an abbreviated form of the IEEE SRS standard which relies on the functional requirements section. This document is also a great overall reference for spec.
###### [830-1998 - IEEE Recommended Practice for Software Requirements Specifications](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/IEEE%20830-1998-SRS-template.pdf) ###### [830-1998 - IEEE Recommended Practice for Software Requirements Specifications](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/IEEE%20830-1998-SRS-template.pdf)
###### [Key words for use in RFCs to Indicate Requirement Levels](https://www.ietf.org/rfc/rfc2119.txt) In every specification, unambiguous language is of paramount importance and to that end it is useful to reference the Key words RFC which clearly specifies the use of the words:
`The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL"`
###### [Key words for use in RFCs to Indicate Requirement Levels](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/rfc/rfc2119.txt)
###### [OGS Design Procedures Manual - Specifications Language](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/specification/OGS_050201SpecificationsLanguage.pdf) ###### [OGS Design Procedures Manual - Specifications Language](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/specification/OGS_050201SpecificationsLanguage.pdf)
Specifications are printed documents that establish procedures and requirements for a particular project. Specifications are legally enforceable as contract documents and must be prepared with concern and respect of their legal status. Specifications should include the correct use of words and grammar with properly constructed sentences and paragraphs. Specifications must be clear, correct, complete, and concise using these guidelines: Specifications are printed documents that establish procedures and requirements for a particular project. Specifications are legally enforceable as contract documents and must be prepared with concern and respect of their legal status. Specifications should include the correct use of words and grammar with properly constructed sentences and paragraphs. Specifications must be clear, correct, complete, and concise using these guidelines:
......