diff --git a/docs/anchors/fagan-inspection.adoc b/docs/anchors/fagan-inspection.adoc new file mode 100644 index 0000000..f888429 --- /dev/null +++ b/docs/anchors/fagan-inspection.adoc @@ -0,0 +1,43 @@ += Fagan Inspection +:categories: testing-quality +:roles: software-developer, qa-engineer, software-architect, team-lead +:related: mutation-testing, testing-pyramid +:proponents: Michael Fagan +:tags: code-review, inspection, defect-detection, formal-review, static-analysis + +[%collapsible] +==== +Also known as:: Formal Code Inspection, Software Inspection, Fagan's Inspection Method + +[discrete] +== Core Concepts: + +Formal inspection process:: A structured, multi-phase review process for software artifacts (requirements, design, code) with defined roles and entry/exit criteria + +Roles:: Moderator (facilitates and logs), Author (created the artifact), Inspectors (reviewers), Recorder (documents defects) + +Six phases:: Planning → Overview → Preparation → Inspection Meeting → Rework → Follow-up + +Entry and exit criteria:: Explicit conditions that must be met before entering and leaving each phase, preventing premature progression + +Defect classification:: Defects are categorized by type (missing, wrong, extra) and severity, enabling process improvement through causal analysis + +Metrics-driven:: Inspection data (defect rate, inspection rate) are collected and used to improve both the product and the inspection process itself + +Key Proponents:: Michael Fagan ("Design and Code Inspections to Reduce Errors in Program Development", IBM Systems Journal, 1976) + +[discrete] +== When to Use: + +* Safety-critical or high-assurance software where defect escape is costly +* Reviewing requirements, architecture, design, or code artifacts early in development +* Establishing a culture of quality and shared code ownership in teams +* When you want measurable, process-level quality improvement over time +* Regulated environments (medical devices, avionics, finance) requiring documented review evidence + +[discrete] +== Related Anchors: + +* <> +* <> +==== diff --git a/docs/anchors/fagan-inspection.de.adoc b/docs/anchors/fagan-inspection.de.adoc new file mode 100644 index 0000000..8995c15 --- /dev/null +++ b/docs/anchors/fagan-inspection.de.adoc @@ -0,0 +1,43 @@ += Fagan-Inspektion +:categories: testing-quality +:roles: software-developer, qa-engineer, software-architect, team-lead +:related: mutation-testing, testing-pyramid +:proponents: Michael Fagan +:tags: code-review, inspection, defect-detection, formal-review, static-analysis + +[%collapsible] +==== +Auch bekannt als:: Formale Code-Inspektion, Software-Inspektion, Fagan's Inspektionsmethode + +[discrete] +== Kernkonzepte: + +Formaler Inspektionsprozess:: Ein strukturierter, mehrphasiger Prüfprozess für Software-Artefakte (Anforderungen, Design, Code) mit definierten Rollen und Ein-/Ausstiegskriterien + +Rollen:: Moderator (leitet und protokolliert), Autor (hat das Artefakt erstellt), Inspektoren (Prüfer), Protokollant (dokumentiert Defekte) + +Sechs Phasen:: Planung → Übersicht → Vorbereitung → Inspektionssitzung → Nachbearbeitung → Nachverfolgung + +Ein- und Ausstiegskriterien:: Explizite Bedingungen, die vor dem Eintritt in und Austritt aus jeder Phase erfüllt sein müssen, um vorzeitiges Voranschreiten zu verhindern + +Fehlerklassifikation:: Fehler werden nach Typ (fehlend, falsch, überflüssig) und Schweregrad kategorisiert, um Prozessverbesserungen durch Ursachenanalyse zu ermöglichen + +Kennzahlengetrieben:: Inspektionsdaten (Fehlerrate, Inspektionsrate) werden gesammelt und zur Verbesserung sowohl des Produkts als auch des Inspektionsprozesses genutzt + +Schlüsselvertreter:: Michael Fagan ("Design and Code Inspections to Reduce Errors in Program Development", IBM Systems Journal, 1976) + +[discrete] +== Wann zu verwenden: + +* Sicherheitskritische oder qualitätsintensive Software, bei der das Entweichen von Fehlern kostspielig ist +* Frühe Überprüfung von Anforderungen, Architektur, Design oder Code-Artefakten +* Aufbau einer Qualitätskultur und gemeinsamen Code-Verantwortung im Team +* Wenn messbare, prozessbasierte Qualitätsverbesserung über die Zeit angestrebt wird +* Regulierte Umgebungen (Medizinprodukte, Luftfahrt, Finanzen), die dokumentierte Prüfnachweise erfordern + +[discrete] +== Verwandte Anker: + +* <> +* <> +==== diff --git a/skill/semantic-anchor-translator/references/catalog.md b/skill/semantic-anchor-translator/references/catalog.md index d22009e..d6666e9 100644 --- a/skill/semantic-anchor-translator/references/catalog.md +++ b/skill/semantic-anchor-translator/references/catalog.md @@ -38,6 +38,11 @@ Source: https://github.com/LLM-Coding/Semantic-Anchors ### Property-Based Testing - **Core:** Test properties/invariants with generated inputs (QuickCheck, Hypothesis) +### Fagan Inspection +- **Also known as:** Formal Code Inspection, Software Inspection +- **Proponents:** Michael Fagan +- **Core:** Structured six-phase review process (Planning, Overview, Preparation, Inspection Meeting, Rework, Follow-up) with defined roles (Moderator, Author, Inspectors, Recorder), entry/exit criteria, and metrics-driven defect classification + ### IEC 61508 SIL Levels - **Proponents:** International Electrotechnical Commission - **Core:** Safety integrity levels for safety-critical systems diff --git a/website/public/data/anchors.json b/website/public/data/anchors.json index 95a3b10..963aa84 100644 --- a/website/public/data/anchors.json +++ b/website/public/data/anchors.json @@ -291,7 +291,7 @@ }, { "id": "devils-advocate", - "title": "Devil’s Advocate", + "title": "Devil\u2019s Advocate", "categories": [ "problem-solving" ], @@ -309,7 +309,7 @@ }, { "id": "diataxis-framework", - "title": "Diátaxis Framework", + "title": "Di\u00e1taxis Framework", "categories": [ "documentation" ], @@ -325,7 +325,7 @@ }, { "id": "docs-as-code", - "title": "Docs-as-Code according to Ralf D. Müller", + "title": "Docs-as-Code according to Ralf D. M\u00fcller", "categories": [ "documentation" ], @@ -426,6 +426,34 @@ "filePath": "docs/anchors/feynman-technique.adoc", "tier": 3 }, + { + "id": "fagan-inspection", + "title": "Fagan Inspection", + "categories": [ + "testing-quality" + ], + "roles": [ + "software-developer", + "qa-engineer", + "software-architect", + "team-lead" + ], + "related": [ + "mutation-testing", + "testing-pyramid" + ], + "proponents": [ + "Michael Fagan" + ], + "tags": [ + "code-review", + "inspection", + "defect-detection", + "formal-review", + "static-analysis" + ], + "filePath": "docs/anchors/fagan-inspection.adoc" + }, { "id": "five-whys", "title": "Five Whys (Ohno)", @@ -491,7 +519,7 @@ "tdd-london-school" ], "proponents": [ - "Aslak Hellesøy" + "Aslak Helles\u00f8y" ], "tags": [ "gherkin", @@ -1298,9 +1326,9 @@ "morphological-box" ], "proponents": [ - "Jörg Becker", + "J\u00f6rg Becker", "Michael Rosemann", - "Rolf Schütte" + "Rolf Sch\u00fctte" ], "tags": [ "modeling", @@ -1431,7 +1459,7 @@ }, { "id": "lasr", - "title": "LASR according to Toth/Zörner", + "title": "LASR according to Toth/Z\u00f6rner", "categories": [ "software-architecture" ], @@ -1449,7 +1477,7 @@ ], "proponents": [ "Stefan Toth", - "Stefan Zörner" + "Stefan Z\u00f6rner" ], "tags": [ "architecture-documentation", @@ -2543,7 +2571,7 @@ }, { "id": "yagni", - "title": "YAGNI (You Aren’t Gonna Need It)", + "title": "YAGNI (You Aren\u2019t Gonna Need It)", "categories": [ "design-principles" ], @@ -2571,4 +2599,4 @@ "filePath": "docs/anchors/yagni.adoc", "tier": 1 } -] \ No newline at end of file +]