Software Reading Techniques

Chapter 1. Introduction * Software quality, software reviews and inspections * What is this book about o 1.2.1 Organization of this book o 1.2.2 Intended audiences and how to use this book * 1.3 References Chapter 2. Software Review Procedures * 2.1 A generic software review procedure * 2.2. Fagan inspection and extensions o 2.2.1 Fagan inspection o 2.2.2 Extensions to Fagan inspection 2.2.2.1 Meeting or no meeting 2.2.2.2 What is the right team size? 2.2.2.3 Other extensions * 2.3 Active design review and extensions o 2.3.1 Active design review o 2.3.2 Extensions to the active design review * 2.4 Other types of reviews * 2.5 Factors impacting software reviews * 2.6 Summary * 2.7 References Chapter 3. Basic Software Reading Techniques * 3.1 Introduction to software reading o 3.1.1 Definition of software reading o 3.1.2 Purposes of software reading o 3.1.2 Taxonomy of software reading techniques * 3.2 Ad hoc reading * 3.3 Checklist-based reading o 3.3.1 Checklist definition, types, and examples o 3.3.2 Checklists with guidance o 3.3.3 Best practices of checklists o 3.3.4 Empirical experiences * 3.4 Differential reading * 3.5 Summary * 3.6 References Chapter 4. Scenario-Based Reading Techniques * 4.1 Principles of scenario-based reading <* 4.2 Defect-based reading o 4.2.1 Taxonomy of defects in requirements specifications o 4.2.2 Defect-based reading techniques o 4.2.3 Empirical experiences * 4.3 Perspective-based reading o 4.3.1 A generic perspective-based reading 4.3.1.1 Reading scenarios and template 4.3.1.2 Developing reading scenarios 4.3.1.3 Characteristics of perspective-based reading o 4.3.2 Perspective-based requirements reading 4.3.2.1 Reading scenarios for requirements specifications 4.3.2.2 Empirical experiences o 4.3.3 Perspective-based design reading 4.3.3.1 Reading scenarios for design documents 4.3.3.2 Empirical experiences o 4.3.4 Perspective-based code reading 4.3.4.1 Reading scenarios for code modules 4.3.4.2 Empirical experiences o 4.3.5 Perspective-based usability reading 4.3.5.1 Reading scenarios for usability 4.3.5.2 Empirical experiences o 4.3.6 Why does perspective-based reading work? 4.3.6.1 Cognitive analysis of perspective-based reading 4.3.6.2 An analytical model * 4.4 Alternative partitioning of reading responsibilities o 4.4.1 Ad hoc partition o 4.4.2 Function point-based partition * 4.5 Summary * 4.6 References Chapter 5. Requirements Reading Techniques * 5.1 Critical roles of requirements in software development * 5.2 A combined reading technique for requirements o 5.2.1 Motivations for a combined reading o 5.3.2 The combined-reading technique o 5.3.3 Empirical experiences * 5.3 Test-case driven reading for requirements o 5.3.1 Test-case driven reading technique o 5.3.2 Empirical experiences * 5.4 Individual factors impacting requirements reading efficiency * 5.5 Summary * 5.6 References Chapter 6. Design Reading Techniques * 6.1 Introduction * 6.2 Usage-based reading o 6.2.1 Usage-based reading technique o 6.2.2 Variations of usage-based reading o 6.2.3 Empirical experiences * 6.3 Traceability-based reading o 6.3.1 Types of design defects o 6.3.2 High-level OO designs using UML diagrams o 6.3.3 Traceability-based reading techniques 6.3.3.1 Horizontal readings * 6.3.3.1.1 Reading 1: Sequence diagrams vs class diagrams * 6.3.3.1.2 Reading 2: State diagrams vs class descriptions * 6.3.3.1.3 Reading 3: Sequence diagrams vs state diagrams * 6.3.3.1.4 Reading 4: Class diagrams vs class descriptions 6.3.3.2 Vertical readings * 6.3.3.2.1 Reading 5: Class descriptions vs requirements descriptions * 6.3.3.2.2 Reading 6: Sequence diagrams vs use cases * 6.3.3.2.3 Reading 7: State diagrams vs requirements descriptions and use cases 6.3.3.3 Semantic checking 6.3.3.4 Practical considerations o 6.3.4 Empirical experiences * 6.4 Architecture reading o 6.4.1 What is software architecture? o 6.4.2 Traceability-based architecture reading o 6.4.3 Empirical experiences o 6.4.4 Other architecture reading techniques * 6.5 Scope-based reading o 6.5.1 What is an application framework? o 6.5.2 Scope-based reading techniques 6.5.2.1 Hierarchy-based reading 6.5.2.2 Example-based reading o 6.5.3 Empirical experiences * 6.6 Summary * 6.7 References Chapter 7. Code Reading Techniques * 7.1 Code reading as a professional skill o 7.1.1 Importance of code reading o 7.1.2 How do people read code? * 7.2 Reading by stepwise abstraction * 7.3 Object-oriented code reading o 7.3.1 Challenges of object-oriented code reading o 7.3.2 Abstraction-driven reading o 7.3.3 Use-case-driven reading o 7.3.4 Empirical experiences * 7.4 Object-oriented framework code reading o 7.4.1 Why yet another object-oriented code reading technique? o 7.4.2 Functionality-based approach to framework understanding o 7.4.3 Functionality-based reading o 7.4.4 Empirical experiences * 7.5 Task-directed inspection * 7.6 Code readability factors * 7.7 Summary * 7.8 References Chapter 8. Conclusion