Skip to content

Commit efe2b44

Browse files
eslookCharlotte Gieltjes
andauthored
docs: keywords en aliassen bepaald - uitbreiden met gerelateerde componenten (#1097)
Onderdeel van #1093 Co-authored-by: Charlotte Gieltjes <charlotte.gieltjes@rebels.io>
1 parent 1ee3815 commit efe2b44

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

.github/ISSUE_TEMPLATE/204-📝-keywords-en-aliassen.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ type: Task
1616
- [ ] Stem af met Design System Lead
1717
- [ ] Voeg de meest gebruikte alternatieven toe aan de component pagina in de candidate repository
1818
- [ ] Voeg de aliassen toe aan de keywords op de component pagina in de documentatie repository
19+
- [ ] Voeg de gerelateerde componenten toe aan de relaties JSON in de documentatie repository
20+
- [ ] Voeg de gerelateerde componenten toe aan de GitHub Discussion
1921
- [ ] Zet de checkpoint in het GitHub projectbord op de juiste status
2022

2123
### Maak de packages beschikbaar voor de nieuwe Candidate component
@@ -54,7 +56,7 @@ Maak een PR aan gebruik hierbij de volgende opzet:
5456

5557
### Verzamel alternatieve namen voor de component
5658

57-
Diverse design systems, Developers en Designers gebruiken verschillende woorden om hetzelfde component mee aan te duiden. Tijdens de Help Wanted fase is de naam van de component bepaald, maar door keywords en aliassen toe te voegen kan de component ook op de namen die we zelf niet gebruiken gevonden worden. Voor de componenten is er op Slack een uitgebreide lijst 'Component Keywords & Aliassen' waar we deze in eerste instantie in verzamelen.
59+
Diverse design systems, Developers en Designers gebruiken verschillende woorden om hetzelfde component mee aan te duiden. Tijdens de Help Wanted fase is de naam van de component bepaald, maar door keywords en aliassen toe te voegen kan de component ook op de namen die we zelf niet gebruiken gevonden worden. Voor de componenten is er op Slack een uitgebreide lijst 'Component Keywords & Aliassen' waar we deze in eerste instantie in verzamelen. Daarnaast kijken we ook naar de gerelateerde componenten die we in dit onderzoek tegenkomen, dit zijn componenten waar gebruikers mogelijk naar op zoek zijn wanneer ze bij deze component terechtkomen.
5860

5961
#### Hoe kun je dit bijvoorbeeld doen?
6062

@@ -63,12 +65,14 @@ Verzamel input:
6365
- Verzamel de huidige keywords voor deze component. Deze vind je in het Slack Canvas "[Component Keywords & Aliassen](https://codefornl.slack.com/docs/T68FXPFQV/F07BH78SAFP)" of in de keywords van de detail pagina van deze component in de documentatie repository. Noteer de resultaten in een comment in de issue.
6466
- Haal input op bij Designers en Developers uit de community door te vragen hoe zij de component ook wel noemen. Bijvoorbeeld middels een Mentimeter WordCloud quiz tijdens een Open Hour. Noteer de resultaten in een comment in de issue.
6567
- Verzamel welke keywords en andere gebruikte woorden voorkomen in het vakgebied. Je vind relevante bronnen in het Slack Canvas "[Inspiratie- en referentiebronnen voor componenten](https://codefornl.slack.com/docs/T68FXPFQV/F0AEQ1Q0WBS)". Noteer de resultaten in een comment in de issue.
68+
- Verzamel welke componenten de community en andere relevante bronnen noemen wanneer ze het over deze component hebben, bijvoorbeeld wanneer een gebruiker eigenlijk een Alert Dialog zoekt maar op een Modal Dialog terechtkomt. Noteer de resultaten in een comment in de issue.
6669

67-
Maak een voorstel:
70+
Maak een voorstel in één comment:
6871

6972
- Combineer de resultaten in en tel op hoevaak ze voorkomen.
7073
- Selecteer de 0 tot 5 meest genoemde keywords en voeg deze toe aan de kolom met 'Aliassen'. Nummer de lijst op volgorde van meest naar minst vaak genoemd.
7174
- Zijn er duidelijk veelgebruikte keywords die ook als je een zoekmachine (Google) gebruikt tot resultaten leiden? Neem deze ook op in Aliassen.
75+
- Maak een voorstel van gerelateerde componenten.
7276
- Stem met Design System Lead af.
7377

7478
Verwerk de uitkomsten:
@@ -136,5 +140,34 @@ keywords:
136140
- **Commit Message**: `docs: candidate aliases as keywords for {naam-component}`
137141
- **Branch**: `docs/candidate-aliases-as-keywords-for-{naam-component}`
138142

143+
### Voeg de gerelateerde componenten toe aan de GitHub Discussion
144+
145+
In de GitHub Discussion, onder het kopje 'Gerelateerde componenten', voeg de gerelateerde componenten toe.
146+
147+
Zoals we bijvoorbeeld hebben gedaan voor Unordered List:
148+
149+
```md
150+
## Gerelateerde componenten
151+
152+
[Ordered List](https://github.com/orgs/nl-design-system/discussions/230), [Rich Text Content](https://github.com/orgs/nl-design-system/discussions/289), [Link List](https://github.com/orgs/nl-design-system/discussions/266), [Task List](https://github.com/orgs/nl-design-system/discussions/295)
153+
```
154+
155+
### Voeg de gerelateerde componenten toe aan de relaties JSON in de documentatie repository
156+
157+
Dat kan in de `relations.json`.
158+
159+
Zoals we bijvoorbeeld hebben gedaan voor Unordered List:
160+
161+
```json
162+
...
163+
164+
"Unordered List": ["Ordered List", "Rich Text Content", "Link List", "Task List"],
165+
166+
...
167+
```
168+
169+
- **Commit Message**: `docs: candidate related components for {naam-component}`
170+
- **Branch**: `docs/candidate-related-components-for-{naam-component}`
171+
139172
🚩 Checkpoint
140173
📝 Zoekwoorden

0 commit comments

Comments
 (0)