Skip to content

Commit 55b6fb6

Browse files
committed
docs: expand preset README guidance
1 parent 22409ff commit 55b6fb6

12 files changed

Lines changed: 2140 additions & 706 deletions

File tree

specs/spec-kit-preset-repos/spec-kit-preset-a11y-governance/README.md

Lines changed: 144 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,122 @@ Version: `0.4.0`
44
Status: published, standard governance preset
55
Priority: `40`
66
Requires: Spec-Kit `>=0.8.0` (uses the `wrap` and `append` composition
7-
strategies introduced in 0.8.x).
7+
strategies introduced in `0.8.x`).
88

99
## Zweck / Purpose
1010

11-
- inject accessibility, bilingual-delivery, and CEFR-B2 readability
12-
expectations into Spec-Kit
13-
- make didactic inline-code-comment review explicit for new or changed
14-
non-trivial logic
15-
- preserve the `Programmierung #include<everyone>` principle as a
16-
reusable preset instead of a local-only policy
11+
Dieses Standard-Preset bringt Barrierefreiheit, DE-first/EN-second
12+
Auslieferung, CEFR-B2-Lesbarkeit und didaktische Inline-Kommentarprüfung in
13+
Spec-Kit-Workflows. Es macht `Programmierung #include<everyone>` als
14+
wiederverwendbare Governance sichtbar, statt diese Regel nur lokal in einem
15+
Repository zu halten.
16+
17+
*This standard preset injects accessibility, DE-first/EN-second delivery,
18+
CEFR-B2 readability, and didactic inline-comment review into Spec-Kit
19+
workflows. It preserves `Programmierung #include<everyone>` as reusable
20+
governance instead of keeping it as a local-only policy.*
21+
22+
Das Qualitätsziel ist, dass nutzerseitige Artefakte auch mit Tastatur,
23+
Screenreader, Braille-Zeile, Textbrowser und klarer Sprache nutzbar bleiben.
24+
Das gilt für CLI-Ausgaben, Dokumentation, HTML, UI und generierte Templates.
25+
26+
*The quality goal is that user-facing artifacts remain usable with keyboard,
27+
screen readers, Braille displays, text browsers, and clear language. This
28+
applies to CLI output, documentation, HTML, UI, and generated templates.*
29+
30+
## Zielgruppen / Audience
31+
32+
Dieses Preset eignet sich, wenn:
33+
34+
- ein Projekt nutzerseitige CLI-, Dokumentations-, HTML-, UI- oder
35+
Template-Artefakte erzeugt;
36+
- Lernende, Fachinformatiker*innen, KDM oder KITSM mit verständlichen
37+
DE-first/EN-second Materialien arbeiten sollen;
38+
- WCAG 2.2 Level AA und CEFR B2 früh in Spec, Plan und Tasks sichtbar sein
39+
sollen;
40+
- nicht-triviale Logik didaktische Kommentare braucht, damit Wartung und
41+
Ausbildung nicht am Codeverständnis scheitern.
42+
43+
*Use this preset for user-facing CLI, documentation, HTML, UI, or template
44+
artifacts; for DE-first/EN-second learning material; when WCAG 2.2 Level AA
45+
and CEFR B2 should be visible early in specs, plans, and tasks; and when
46+
non-trivial logic needs didactic comments for maintainability and learning.*
47+
48+
## Lieferumfang / What It Provides
49+
50+
- Addenda für Constitution, Spec, Plan, Tasks und Agent-Guidance
51+
- Wrapper für `speckit.specify`, `speckit.plan` und `speckit.tasks`
52+
- Templates für A11Y-Review, bilinguale Inhaltsprüfung, CLI-A11Y,
53+
A11Y-Evidence und didaktische Code-Kommentarprüfung
54+
- auditfähige Spec-Kit-Run-Evidence-Felder für Anwendbarkeit, N/A-Begründung,
55+
Reviewer, Evidence-Pfad, Restrisiko und Follow-up
56+
57+
*The preset provides addenda for the main Spec-Kit artifacts and agent
58+
guidance, wraps the normal Specify/Plan/Tasks flow, and supplies templates for
59+
accessibility review, bilingual content checks, CLI accessibility, evidence,
60+
and didactic code-comment review.*
61+
62+
## Nicht enthalten / What It Does Not Provide
63+
64+
Das Preset führt keine Accessibility-Scanner, Screenreader-Tests,
65+
Übersetzungsprüfung oder UI-Automation selbst aus. Es ersetzt keine Prüfung
66+
durch betroffene Nutzergruppen und erteilt keine Repository-, Merge-,
67+
Deployment- oder Provider-Administrationsrechte.
68+
69+
*The preset does not run accessibility scanners, screen-reader tests,
70+
translation review, or UI automation by itself. It does not replace review
71+
with affected user groups and grants no repository, merge, deployment, or
72+
provider-administration authority.*
73+
74+
## Voraussetzungen / Prerequisites
75+
76+
1. kompatible GitHub Spec Kit CLI;
77+
2. gültige Spec-Kit-Integration im Ziel-Repository;
78+
3. versionierte Constitution und Agent-Guidance;
79+
4. geklärter Evidence-Ort, standardmäßig `docs/accessibility/`;
80+
5. bekannte Zielgruppen, Artefakttypen und Sprachebene.
81+
82+
*Before installation, use a compatible GitHub Spec Kit CLI, a valid Spec-Kit
83+
integration, versioned constitution and agent guidance, a clear evidence
84+
location, and known target audiences, artifact types, and language level.*
1785

1886
## Installation / Install
1987

88+
### Veröffentlichter Tag / Published Tag
89+
2090
```bash
2191
specify preset add \
2292
--from https://github.com/hindermath/spec-kit-preset-a11y-governance/archive/refs/tags/v0.4.0.zip \
2393
--priority 40
2494
specify preset info a11y-governance
2595
```
2696

97+
### Entwicklungs-Checkout / Development Checkout
98+
2799
```bash
28100
specify preset add --dev /path/to/a11y-governance --priority 40
29101
specify preset info a11y-governance
30102
```
31103

104+
### Empfohlene Kombination / Recommended Composition
105+
106+
| Priority | Preset |
107+
|---:|---|
108+
| 10 | `security-governance` |
109+
| 20 | `architecture-governance` |
110+
| 30 | `isaqb-architecture-governance` |
111+
| 40 | `a11y-governance` |
112+
| 50 | `cross-platform-governance` |
113+
| 60 | `agent-parity-governance` |
114+
115+
Dieses Preset liegt nach Security und Architektur, damit nutzerseitige
116+
Artefakte, Dokumentation, Templates und Lernmaterialien in der gleichen
117+
Spec-Kit-Komposition geprüft werden.
118+
119+
*This preset runs after security and architecture so user-facing artifacts,
120+
documentation, templates, and learning material are checked in the same
121+
Spec-Kit composition.*
122+
32123
## Quellkapitel / Source Chapters
33124

34125
- `VII. Programmierung #include<everyone> — Inclusion & Accessibility By
@@ -76,6 +167,21 @@ specify preset info a11y-governance
76167

77168
Default evidence location: `docs/accessibility/`.
78169

170+
## Prüfung / Verification
171+
172+
```bash
173+
specify preset list
174+
specify preset info a11y-governance
175+
specify preset resolve
176+
specify check
177+
```
178+
179+
Prüfe zusätzlich, ob nutzerseitige Artefakte im Plan benannt sind und ob N/A
180+
für WCAG, Bilingualität oder CEFR B2 begründet wurde.
181+
182+
*Also verify that user-facing artifacts are named in the plan and that N/A
183+
decisions for WCAG, bilingual delivery, or CEFR B2 are justified.*
184+
79185
## Einsatz / When to Use
80186

81187
- any project that produces user-facing `CLI`, `documentation`, `HTML`,
@@ -90,6 +196,24 @@ Default evidence location: `docs/accessibility/`.
90196
- purely internal artefacts with no user-facing surface at all
91197
- teams that do not want DE-first / EN-second guidance
92198

199+
## Fehlersuche / Troubleshooting
200+
201+
### Kein UI vorhanden / No UI Exists
202+
203+
Prüfe CLI-Ausgaben, Dokumentation und Templates trotzdem. Diese Artefakte sind
204+
nutzerseitig, wenn Menschen sie lesen, bedienen oder bearbeiten.
205+
206+
### N/A ist zu pauschal / N/A Is Too Broad
207+
208+
Trenne Artefakttypen. Ein Projekt ohne HTML-UI kann trotzdem CLI- und
209+
Dokumentations-A11Y brauchen.
210+
211+
### Kommentare fehlen / Comments Are Missing
212+
213+
Bewerte nicht jede öffentliche Funktion mechanisch gleich. Kommentare sind
214+
erforderlich, wenn nicht-triviale Logik, Lernkontext, Randbedingungen oder
215+
Trade-offs sonst schwer verständlich bleiben.
216+
93217
## Sicherheit und Grenzen / Safety and Boundaries
94218

95219
- Installation adds governance prompts, templates, and wrapped Spec-Kit
@@ -112,3 +236,16 @@ Default evidence location: `docs/accessibility/`.
112236
documents and checklists can record applicability, N/A rationale, reviewer,
113237
evidence path, residual risk, and follow-up per standards-relevant Spec-Kit
114238
run.
239+
240+
## Kompatibilitäts- und Sicherheitsübersicht / Compatibility and Safety Summary
241+
242+
- kompatibel mit Spec-Kit `>=0.8.0`
243+
- priorisiert als Stufe `40`
244+
- deckt CLI, Dokumentation, HTML, UI und generierte Templates ab
245+
- keine automatischen Scanner-, Remote-, Merge- oder Provider-Aktionen
246+
- WCAG-, CEFR-, Bilingualitäts- und Kommentarentscheidungen bleiben
247+
projektbezogene Evidence
248+
249+
## License
250+
251+
MIT. See `LICENSE`.

0 commit comments

Comments
 (0)