| ... | ... | @@ -9,7 +9,7 @@ The first step you must take as a developer BEFORE starting any project, job, or |
|
|
|
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 learning about software specifications.
|
|
|
|
###### REF - [830-1998 - IEEE Recommended Practice for Software Requirements Specifications](https://vc.digitec.local/digitec/digitec-wiki/blob/master/wiki-assets/files/specification/IEEE%20830-1998-SRS-template.pdf)
|
|
|
|
---
|
|
|
|
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:
|
|
|
|
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:
|
|
|
|
"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)
|
|
|
|
---
|
| ... | ... | @@ -17,7 +17,7 @@ Words matter, especially when you are legally binding yourself to the delivery o |
|
|
|
|
|
|
|
It may be worth noting that at times the role of client can be played played by the project manager or other personnel requesting the job. Although this spec is destined for internal use, it is just as necessary as one that is destined for a client.
|
|
|
|
|
|
|
|
The end result should be that the developer is ensured a properly scoped job, in which the requirements he must satisfy are clear. Any new requirements that come up can be confidently labeled _out of scope_ and the developer is protected from having to fulfill them without a re-negotiation. For the client it means, a clear articulation of the job requirements which legally ensure that the client is getting what he paid for.
|
|
|
|
The end result should be that the developer is ensured a properly scoped job, in which the requirements he must satisfy are clear. Any new requirements that come up can be confidently labeled __out of scope__ and the developer is protected from having to fulfill them without a re-negotiation. For the client it means, a clear articulation of the job requirements which legally ensure that the client is getting what he paid for.
|
|
|
|
|
|
|
|
#### The following text is a great guideline for the type of language that you must use when writing a specification.
|
|
|
|
|
| ... | ... | |
