Skip to content

Commit 62a08c5

Browse files
Update: templates varianten bepaald en anatomie (#1091)
Co-authored-by: Yolijn <mail@yolijn.com>
1 parent 6710993 commit 62a08c5

File tree

2 files changed

+114
-21
lines changed

2 files changed

+114
-21
lines changed

.github/ISSUE_TEMPLATE/202-📝-varianten-bepaald.md

Lines changed: 108 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Component is, waar nodig, versimpeld of opgesplitst. Zodat er één of meerdere
1515
- [ ] Verzamel input uit de Community
1616
- [ ] Besluit welke varianten Candidate worden
1717
- [ ] Documenteer besluit in de GitHub Discussion
18-
- [ ] Documenteer besluit in de Candidate repository
1918
- [ ] Zet de checkpoint in het GitHub projectbord op de juiste status
2019

2120
### Verzamel input uit de Community
@@ -114,41 +113,137 @@ Voorbeeld hypothese voor RVO met 4 verschillende formaten voor font-size:
114113

115114
### Besluit welke varianten Candidate worden
116115

117-
- Overleg de naam en beschrijving met het kernteam
118-
- Bepaal samen met de Design System Lead welke varianten in de Candidate component moeten worden opgenomen
119-
- Notuleer de besproken beredeneringen op, deze heb je nodig in de volgende stap.
116+
- Overleg de naam en beschrijving met het kernteam.
117+
- Bepaal samen met de Design System Lead welke varianten in de Candidate component moeten worden opgenomen.
118+
- Is het een variant die hoort bij een standaard HTML attribuut? Bepaal dan welke varianten wel worden ondersteund en ook geadviseerd worden, welke ondersteund worden maar niet geadviseerd worden en welke er niet ondersteund worden.
119+
- Notuleer de besproken beredeneringen. Deze heb je nodig in de volgende stap. Dat doe je met een comment in dit GitHub issue met een comment:
120+
121+
```md
122+
## Input type
123+
124+
### ondersteund:
125+
126+
- text
127+
- search
128+
- tel
129+
- url
130+
- email
131+
- password
132+
133+
### ondersteund maar niet geadviseerd:
134+
135+
- hidden
136+
- :not([type])
137+
- date
138+
- month
139+
- week
140+
- time
141+
- datetime-local
142+
- number
143+
144+
### niet ondersteund:
145+
146+
- color
147+
- range
148+
- radio
149+
- checkbox
150+
- file
151+
- submit
152+
- image
153+
- reset
154+
- button
155+
```
120156

121157
### Documenteer besluit
122158

123-
- Optioneel: splits, in overleg met de Design System Lead, de component op in meerdere componenten en zet de extra componenten met logica die we daarin gaan opnemen op de Backlog.
159+
- Optioneel: splits, in overleg met de Design System Lead, de component op in meerdere componenten. Zet de extra componenten, met logica die we daarin gaan opnemen, op de Backlog.
124160
- Documenteer in de GitHub Discussion welke varianten wel en niet worden meegenomen voor de Candidate implementatie en waarom.
125161

126162
```md
127163
## Candidate voorbereidingsfase: Versimpeld of gesplitst
128164

129-
De varianten voor de Candidate component zijn bepaald, dat hebben we gedaan op basis van alle voorbeelden die we in deze Discussion hebben gezien. Als een variant veel voor komt, dan is het een algemeen nuttige variant!
165+
De varianten voor de Candidate component zijn bepaald, dat hebben we gedaan op basis van alle voorbeelden die we in deze Discussion hebben gezien. Als een variant veel voorkomt, dan is het een algemeen nuttige variant!
130166

131-
### Deze varianten nemen we mee:
167+
### Deze varianten ondersteunen we:
132168

133-
**{variant-groep}** - {enum / boolean / string)
169+
**{variant-groep}** - (enum / boolean / string)
134170

171+
- {variant-naam}(default)
135172
- {variant-naam}
136173
- {variant-naam}
137-
- {variant-naam}
138174

139-
### Deze varianten nemen we niet mee:
175+
### Deze varianten ondersteunen we niet:
176+
177+
optioneel: welke varianten hebben we besloten om niet te supporten? Zie hiervoor de notulen in dit GitHub issue.
140178

141-
{optioneel: welke varianten zijn zo smerig dat we ze niet hebben meegenomen? Beschrijf ook waarom}
179+
### Deze varianten ondersteunen we, maar raden we niet aan:
180+
181+
optioneel: welke varianten supporten we omdat ze standaard in HTML zitten, maar gaan we niet documenteren, niet beschikbaar maken in Figma en alleen meenemen in de test Storybook? Zie hiervoor de notulen in dit GitHub issue
142182

143183
### Mis je een variant?
144184

145185
Laat het in deze Discussion weten als er uit gebruikersonderzoek naar voren is gekomen dat deze design beslissing een hele verbetering zou zijn.
146186

147187
**💡 Tip**
148-
Je kunt varianten ook als extentie toevoegen aan de component. Documentatie hoe je dan kunt doen volgt. Vraag ons er gerust naar.
188+
Je kunt [varianten ook als extensie toevoegen](https://www.nldesignsystem.nl/handboek/componenten-vinden/#ik-mis-een-functionaliteit-binnen-een-candidate-of-hall-of-fame-component-wat-nu) aan een component.
189+
```
190+
191+
Zijn er geen varianten? Documenteer dat dan ook in de GitHub Discussion.
192+
193+
```md
194+
## Candidate voorbereidingsfase: Versimpeld of gesplitst
195+
196+
Er zijn meerdere implementaties van {component-naam} bekeken en met elkaar vergeleken. Op basis daarvan is besloten dat er géén specifieke varianten nodig zijn voor de Candidate component.
149197
```
150198

151-
- Zet de naam en beschrijving van de varianten die we gaan meenemen naar Candidate in de GitHub Backlog issue van de component. Maak acceptatiecriteria voor alle varianten die in de component worden meegenomen. Voeg deze toe aan de `acceptance-criteria.md` van de component in de Candidate repository.
199+
#### Voeg de besluiten toe aan de acceptatiecriteria
200+
201+
Maak acceptatiecriteria voor alle varianten die in de component worden meegenomen. Voeg deze toe aan de `acceptance-criteria.md` van de component in de Candidate repository.
202+
203+
```md
204+
## Welke varianten ondersteunen we voor deze component
205+
206+
Deze varianten worden ondersteund. Wanneer ze standaard in HTML zitten worden ze in Typescript gedefinieerd door de attributen het standaard HTMLElement te gebruiken. Wanneer ze niet standaard in HTML zitten wordt deze type extended. Deze varianten worden gedocumenteerd op de website, in de README en in de standaard Storybook. Deze varianten worden beschikbaar gemaakt in Figma.
207+
208+
**{variant-groep}** - (enum / boolean / string / number)
209+
210+
{
211+
Is het een enum? Noteer dan de waardes en of er een default is
212+
213+
- {variant-naam}(default)
214+
- {variant-naam}
215+
- {variant-naam}
216+
217+
Is het een boolean? Noteer dan de twee opties en welke de default is
218+
219+
- true (default)
220+
- false
221+
222+
Is het een string of number? Laat deze dan leeg
223+
}
224+
225+
### Deze varianten ondersteunen we niet:
226+
227+
{
228+
optioneel:
229+
230+
Deze varianten die standaard in HTML zitten worden niet ondersteund. Ze worden uit de HTMLElement type gehaald met Omit bij het definieren van de properties van de component in Typescript.
231+
232+
Deze varianten worden ook niet gedocumenteerd en niet meegenomen in Figma.
233+
234+
Documenteer de niet ondersteunde varianten op basis van de notulen in dit GitHub issue.
235+
}
236+
237+
### Deze varianten ondersteunen we, maar raden we niet aan:
238+
239+
{
240+
optioneel:
241+
242+
Deze varianten supporten we omdat ze standaard in HTML zitten door de HTMLElement type te extenden in Typescript. Deze varianten worden meegenomen in de test Storybook. Deze varianten worden niet gedocumenteerd op de website of in de README, niet beschikbaar in Figma en niet meegenomen in de standaard Storybook.
243+
244+
Documenteer de ondersteunde, maar niet aangeraden varianten op basis van de notulen in dit GitHub issue.
245+
}
246+
```
152247

153248
🚩 Checkpoint
154249
📝 Varianten bepaald: Done

.github/ISSUE_TEMPLATE/205-📝-anatomie-bepaald.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ type: Task
1616
- [ ] Maak een voorstel voor de anatomie
1717
- [ ] Bepaal of de anatomie zo kan worden meegenomen in de Candidate implementatie
1818
- [ ] Stem af met Design System Lead
19-
- [ ] Documenteer besluit in de Candidate repository
19+
- [ ] Documenteer besluit in de GitHub Discussion
2020
- [ ] Zet de checkpoint in het GitHub projectbord op de juiste status
2121

22-
### Bepaal welke onderdelen de component uit kan bestaan
22+
### Bepaal uit welke onderdelen de component kan bestaan
2323

2424
Bepaal op basis van de "Component gebruikt", "WCAG-input", "Issues bekend" en "Versimpeld of opgesplitst" fases uit welke onderdelen de component kan bestaan.
2525

2626
### Maak een voorstel voor de anatomie
2727

28-
Is er een anatomie nodig? Leg deze dan in de volgende stappen vast en maak een schets om deze uit te leggen. Dat mag op papier, met een foto. Het mag in Figma, het mag in code. Het doel is dat we als kernteam weten wat ons te doen staat als we de component maken. We leggen het vast om voor beheer als alles nóg een keer gemaakt zou moeten worden in een heel andere techniek het makkelijk te maken om dezelfde afwegingen niet nog een keer te hoeven maken
28+
Is er een anatomie nodig? Leg deze dan in de volgende stappen vast en maak een schets om deze uit te leggen. Dat mag op papier, met een foto. Het mag in Figma, het mag in code. Het doel is dat we als kernteam weten wat ons te doen staat als we de component maken. We leggen het vast om voor beheer als alles nóg een keer gemaakt zou moeten worden in een heel andere techniek het makkelijk te maken om dezelfde afwegingen niet nog een keer te hoeven maken.
2929

3030
#### Welke richtlijnen volg je bij het besluiten van de anatomie?
3131

@@ -44,25 +44,23 @@ Maak een schets van de anatomie op een manier die voor jou het best werkt. Dat k
4444
>
4545
> **Stappen voor Figma**
4646
>
47-
> - Open de Documentatie website afbeeldingen Figma file.
47+
> - Open de ['Documentatie website afbeeldingen' Figma file](https://www.figma.com/design/0Y9Tbb373u6QGxGT6mqUnm/NL-Design-System---Doc-website---Afbeeldingen?node-id=3-23&t=RFNr3Ko3v4JUtIvr-1).
4848
> - Dupliceer een reeds bestaande page.
4949
> - Geef de page de naam van de component.
5050
> - Geef het frame de naam anatomy.
51-
> - Plaats de component vanuit de 'NL Design System - Bibliotheek' op het frame.
5251
> - Gebruik de 'Annotation number' en 'Annotation line' om onderdelen een te wijzen en nummeren. Probeer 48 spacing aan te houden tussen 'Annotation number' en de gehele component.
53-
> - Exporteer het frame als plaatje en voeg deze toe aan de betreffende Backlog issue van de component.
5452
5553
### Bepaal of de anatomie zo kan worden meegenomen in de Candidate implementatie
5654

5755
Zorg voor een meeting waar tenminste een designer, een developer, een toegankelijkheidsspecialist en de Design System Lead uit het kernteam bij aanwezig zijn. Besluit op basis van het voorstel of deze onderdelen inderdaad in de component moeten zitten, of er onderdelen missen en of iedereen het met de naamgeving eens is.
5856

5957
Tip: Zorg dat iedereen genoeg informatie heeft om niet alleen hun eigen expertise te gebruiken, maar ook alle relevante input die uit de community is verzameld in de eerdere stappen voor Candidate.
6058

61-
### Leg de anatomie vast in het GitHub issue
59+
### Leg de anatomie vast in de GitHub Discussion
6260

6361
Let op: Anatomie is niet altijd nodig. Soms bestaat de component maar uit 1 onderdeel. Check dus eerst met elkaar of de component écht uit meerdere onderdelen bestaat voordat je dieper op de anatomie ingaat.
6462

65-
Voeg de schets toe aan de Backlog issue van de component in combinatie met de beschreven Anatomie uit de vorige stappen.
63+
Voeg de schets toe aan de GitHub Discussion van de component in combinatie met de beschreven Anatomie uit de vorige stappen.
6664

6765
Tip: heb je de schets gemaakt met een tool waarvan je de URL kan delen voor het geval deze ooit moet worden aangepast? Deel deze dan ook bij het plaatje.
6866

0 commit comments

Comments
 (0)