Skip to content

GitLab

digitec spec process · Changes

Page history
rcabral created page: digitec-spec-process authored by Rene Cabral's avatar Rene Cabral
Show whitespace changes
Inline Side-by-side
digitec-spec-process.markdown
View page @ 4cddd7ae
...@@ -13,9 +13,8 @@ In every specification, unambiguous language is of paramount importance and to t ...@@ -13,9 +13,8 @@ In every specification, unambiguous language is of paramount importance and to t
"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL"
###### REF - [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) ###### REF - [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)
--- ---
Words matter, especially when you are legally binding yourself to the delivery of services. The language you use in the specification should observe a criteria that ensures clarity for both the developer (writer of the spec) and the client.
###### REF - [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:
1. Clear: Use correct grammar and simple sentences to avoid ambiguity. Carefully selected words to convey exact meanings. 1. Clear: Use correct grammar and simple sentences to avoid ambiguity. Carefully selected words to convey exact meanings.
...@@ -24,6 +23,10 @@ Specifications are printed documents that establish procedures and requirements ...@@ -24,6 +23,10 @@ Specifications are printed documents that establish procedures and requirements
4. Concise: Eliminate unnecessary words, but not at the expense of clarity, 4. Concise: Eliminate unnecessary words, but not at the expense of clarity,
correctness, or completeness. correctness, or completeness.
###### REF - [OGS Design Procedures Manual - Specifications Language](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/specification/OGS_050201SpecificationsLanguage.pdf)
---
##### The process: ##### The process:
......