General Requirements Guidelines - Simm Section 170a - California Department Of Technology Page 15
ADVERTISEMENT
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
183.2 Requirements: Do, Do Not and Avoid
This table contains information that should be referenced when creating IT solicitation documentation and when writing requirements. The
application of this quick-use guide will help create clear and concise requirements. Refer to SIMM Section 170A Exhibit A: Strong
Requirement Samples.
Table 5: Requirements Do, Do Not and Avoid
Do
Do Not
Avoid
Document requirements in a
Use the nouns: “ability” or “capability”.
Compound requirements.
sequential (and not duplicative)
Write requirements that make reference to
Unclear terms such as "real-time." If
numbering schema.
future “deliverables.”
the intent is to set a minimum amount
Use simple sentences.
of time allowable for a process or
Use the term "workflow,"
function to occur, consider specifying
Choose words and terms that are
“seamless/seamlessness,” or “performance”
a measurable limit (e.g., number of
simple and clearly understood.
without first formally defining.
milliseconds). If you must use terms
Select words carefully and use them
Use the term “proven practice" – unless
like "real-time", be sure to add a
glossary item for the term so that the
there is written “proof” attached/provided.
for precise meaning. Once a word is
project's expectations are defined.
selected, use it consistently
Rely on a bidder’s/contractor’s subjective
throughout the document(s)
Complicated sentences in which
opinion as how a requirement was
whenever the same meaning is
omission or insertion of punctuation
intended.
intended.
could change the meaning or create
Use negative expression to convey ideas.
Use positive expression to convey
ambiguity.
Example: “Does not apply to claims with
ideas. Example: “Applies to all claims
Abbreviations with more than one
modification <X>”.
that have not been modified.... “
meaning whenever possible—“When
Use the word “same" as a pronoun. For
Spell out acronyms on first use.
in doubt, spell it out."
example, “The interface must be user
Subsequent use of the acronym in
Abbreviations of short words that
friendly and the application the same.”
the document is preferred.
save one or two characters.
Use adjectives like "excessive," "adequate,"
Capitalize the initial letter of certain
Using words that have missing
and "sufficient.” These words are
project specific nouns and proper
objects like “as appropriate,” “as
problematic.
names defined in a solicitation.
indicated,” “as necessary,” “as
Use ambiguous words like "support,"
required,” or “as directed.”
Omit unnecessary words.
"open," "consider," or “avoid."
Do
Do Not
Avoid
California Department of Technology
14
SIMM Section 170A
General Requirements Guidelines
July 2016
ADVERTISEMENT
0 votes
Related Articles
Related forms
Eligibility Complaint Of Discrimination Under The Provisions Of The California Fair Employment And Housing Act Template- California Department Of Fair Employment And Housing
Legal
Related Categories
Parent category: Legal