Writing Guidelines for Technical Requirements
PDF/UA Home > 14289 DraftingTechnical requirements address:
- Functionality: What is the PDF document/form supposed to do?
- External interfaces: How does the PDF document/form interact with people, the system’s hardware, other hardware, assistive technology, and other software?
- Performance: What is the quality, capacity, reliability, availability, response time, recovery time, download time of various functions and features, etc.?
- Attributes: What are the portability, correctness, maintainability, security, etc. considerations?
- Constraints/Limitations: Are there any required standards in effect, implementation language, policies for database integrity, resource limits, operating environment(s) etc.?
Technical requirements do not address:
Implementation (how)
Technical requirements are:- Correct
- Unambiguous
- Specific
- Complete
- Non-redundant
- Consistent
- Measurable
- Quantifiable
- Modifiable
- Traceable
- Relevant
- Attainable
- Feasible
- Terse
- Within scope
- Non-complex (i.e., not a compound or complex sentence that is really 2 or more requirements)
- Ranked (shall vs. should)
- Independent (does not rely on another requirement to be understood)
Language:
- Requirements use shall (and must be verifiable).
- Goals use should.
- Options use can or may.
- Statements of fact use will
Use these words to indicate illustrative information:
- Figure
- Table
- For example
- Note
Don't use ambiguous or weak terms, such as:
- user-friendly
- easy
- sufficient
- adequate
- quick
- adequate
- be able to
- provide for
- at a minimum
- at a maximum
- be capable of
- effective
- timely
- as applicable
- but not limited to
- if possible
- tbd
- as appropriate
- capability of
- if practical
- normal
- support
- etc.
- and/or
- Correct
- Unambiguous
- Specific
- Complete
- Non-redundant
- Consistent
- Measurable
- Quantifiable
- Modifiable
- Traceable
- Relevant
- Attainable
- Feasible
- Terse
- Within scope
- Non-complex (i.e., not a compound or complex sentence that is really 2 or more requirements)
- Ranked (shall vs. should)
- Independent (does not rely on another requirement to be understood)
Language:
- Requirements use shall (and must be verifiable).
- Goals use should.
- Options use can or may.
- Statements of fact use will
Use these words to indicate illustrative information:
- Figure
- Table
- For example
- Note
Don't use ambiguous or weak terms, such as:
- user-friendly
- easy
- sufficient
- adequate
- quick
- adequate
- be able to
- provide for
- at a minimum
- at a maximum
- be capable of
- effective
- timely
- as applicable
- but not limited to
- if possible
- tbd
- as appropriate
- capability of
- if practical
- normal
- support
- etc.
- and/or
- Figure