Checklist for Requirements Specification Reviews

Transcription

1 Checklist for Requirements Specification Reviews Organization and Completeness o Are all internal cross-references to other requirements correct? o Are all requirements written at a consistent and appropriate level of detail? o Do the requirements provide an adequate basis for design? o Is the implementation priority of each requirement included? o Are all external hardware, software, and communication interfaces defined? o Have algorithms intrinsic to the functional requirements been defined? o Does the specification include all of the known customer or system needs? o Is the expected behavior documented for all anticipated error conditions? Correctness o Do any requirements conflict with or duplicate other requirements? o Is each requirement written in clear, concise, unambiguous language? o Is each requirement verifiable by testing, demonstration, review, or analysis? o Is each requirement in scope for the project? o Is each requirement free from content and grammatical errors? o Is any necessary information missing from a requirement? If so, is it identified as TBD? o Can all of the requirements be implemented within known constraints? o Are any specified error messages unique and meaningful? Quality Attributes o Are all performance objectives properly specified? o Are all security and safety considerations properly specified? o Are other pertinent quality attribute goals explicitly documented and quantified, with the acceptable tradeoffs specified? Traceability o Is each requirement uniquely and correctly identified? o Is each software functional requirement traceable to a higher-level requirement (e.g., system requirement, use case)? Special Issues o Are all requirements actually requirements, not design or implementation solutions? o Are all time-critical functions identified, and timing criteria specified for them? o Have internationalization issues been adequately addressed?

2 Checklist for Architecture Reviews o Does the architecture allow for implementation of all of the requirements? o Has the architecture been adequately decomposed? o Have the system functions been appropriately allocated to components? o Does the architecture provide an adequate base for subsequent design work? o Is the architecture feasible for implementation? o Have maintainability issues been adequately addressed? o Can the program set be integrated and tested in an incremental fashion? Correctness o Does the architecture avoid unnecessary redundancy? o Have all reliability and performance requirements been addressed? o Have all security considerations been addressed? o Does the architecture consider all existing constraints? o Are all necessary, and only the necessary, data structures defined? o Will the proposed architecture satisfy all specified quality attributes and performance goals? Standards and Traceability o Have all architecture standards been followed? o Can all parts of the architecture be traced back to requirements? o Are standard, not proprietary, components being used wherever possible? Logic o Is there any missing or incomplete logic? o Are all possible states or cases considered? Interfaces o Are all interfaces clear and well-defined? o Is the minimum data passed at each interface? o Is minimum global system data added or impacted? Clarity o Is the architecture, including the data flow, control flow, and interfaces, clearly represented? o Are multiple representations of the design consistent with each other? o Are all of the decisions, dependencies, and assumptions for this design documented?

3 Checklist for High-Level Design Reviews o Has the design been decomposed to the point at which the next phase of design can begin? o Has each component been completely and testably specified? o Is the modular decomposition consistent with local standards for modular strength and coupling? Data o Are global constants and passed data parameterized? o Has all the data been properly defined? o Are data structures and element names meaningful and compliant with naming conventions? Correctness and Completeness o Does the high-level design implement all of the requirements? o Has all of the infrastructure (backup, recovery, checkpoints, etc.) been addressed? o Have all quality attributes and performance requirements been designed? o Have internationalization issues been properly and adequately addressed? o Have processing priorities been addressed? o Have feasibility and economical analyses been done to determine that required performance and technical goals will be achievable by this design? o Is there a memory budget to allocate estimated storage requirements for each module, table, and file? o Have all security considerations been designed? o Does the high-level design consider all existing constraints? o Does the high-level design contain unnecessary redundancy? o Have maintainability issues been adequately addressed? o Is the high-level design complete, correct, and unambiguous? Standards and Traceability o Have all design standards been followed? o Does the human interface follow project standards? o Can all parts of the high-level design be traced back to requirements? Interfaces o Are all interfaces clear and well-defined? o Is minimum data passed at each interface? o Is minimum global system data added or impacted by the design? Robustness o Have self-test, fail-safe, and degraded mode requirements been accounted for? o Has an error handling mechanism been identified? o Are unusual situations handled reasonably and nondestructively?

4 Checklist for Detailed Design Reviews o Is the pseudocode or other representation format consistent in its level of detail? Data o Has all the data been properly defined and initialized? o Is all defined data used? o Do the data element names and types conform to the project data dictionary? o Are defaults used, and are they correct? Correctness and Completeness o Is the detailed design a complete and accurate implementation of the high-level design? o Are the external specifications of each module complete and testable? o Have all numerical techniques been analyzed for accuracy? o Has critical timing been analyzed? o Has the high-level design memory budget been expanded into further detail and updated? o Are all functions clearly specified and logically independent? o Have maintainability issues been adequately addressed? o Does each module have high internal cohesion? o Does each module have low external coupling? o Is the detailed design verifiable? o Is the logic correct, clear, and complete? o Have all user interfaces been completely designed? o Can the termination conditions for loops be realized? o Can all logic be tested? Standards and Traceability o Have all detailed design standards been followed? o Does the calling protocol follow project standards? o Can all parts of the detailed design be traced back to the high-level design and to requirements? Robustness o Are error conditions handled in a nondestructive manner? o Can corrective action be taken by the module that traps an error? o Are unusual conditions handled reasonably and nondestructively?

5 Generic Checklist for Code Reviews o Does the code completely and correctly implement the design? o Does the code conform to any pertinent coding standards? o Is the code well-structured, consistent in style, and consistently formatted? o Are there any uncalled or unneeded procedures or any unreachable code? o Are there any leftover stubs or test routines in the code? o Can any code be replaced by calls to external reusable components or library functions? o Are there any blocks of repeated code that could be condensed into a single procedure? o Is storage use efficient? o Are symbolics used rather than magic number constants or string constants? o Are any modules excessively complex and should be restructured or split into multiple routines? Documentation o Is the code clearly and adequately documented with an easy-to-maintain commenting style? o Are all comments consistent with the code? Variables o Are all variables properly defined with meaningful, consistent, and clear names? o Do all assigned variables have proper type consistency or casting? o Are there any redundant or unused variables? Arithmetic Operations o Does the code avoid comparing floating-point numbers for equality? o Does the code systematically prevent rounding errors? o Does the code avoid additions and subtractions on numbers with greatly different magnitudes? o Are divisors tested for zero or noise? Loops and Branches o Are all loops, branches, and logic constructs complete, correct, and properly nested? o Are the most common cases tested first in IF- -ELSEIF chains? o Are all cases covered in an IF- -ELSEIF or CASE block, including ELSE or DEFAULT clauses? o Does every case statement have a default? o Are loop termination conditions obvious and invariably achievable? o Are indexes or subscripts properly initialized, just prior to the loop? o Can any statements that are enclosed within loops be placed outside the loops? o Does the code in the loop avoid manipulating the index variable or using it upon exit from the loop? Defensive Programming o Are indexes, pointers, and subscripts tested against array, record, or file bounds? o Are imported data and input arguments tested for validity and completeness? o Are all output variables assigned? o Are the correct data operated on in each statement? o Is every memory allocation deallocated? o Are timeouts or error traps used for external device accesses? o Are files checked for existence before attempting to access them? o Are all files and devices are left in the correct state upon program termination?

6