Documentatie voor mensen die documentatie schrijven

[Robbert]

Doelen van de documentatie is dat mensen de volgende doelen halen:

Hoogste prio (dingen die het huidige team graag wil weten):

• [ ] Hoe kan ik het beste dependencies import-en? /root/-relative, of via een npm package, of via een @site/ TypeScript path.

Medium prio (dingen voor nieuwe teamleden)

• [ ] je kan een nieuwe documentatie-pagina maken, en je weet waar
• [ ] je kunt bestaande pagina's vinden in de directory-structuur
• [ ] je kan een Markdown snippet hergebruiken in een andere pagina
• [ ] je kan HTML plus Markdown combineren in één pagina
• [ ] je kan componenten uit het design system verwerken in MDX-bestand
• [ ] wanneer gebruik ik een Markdown-file standalone.md, wanneer een Markdown partial (_partial.md), en wanneer gebruik ik MDX?
• [ ] npm package met documentatie:
  • [ ] je kunt uitleggen hoe je documentatie-snippets kan hergebruiken in externe projecten
  • [ ] hoe wordt de npm package met documentatie gepubliceerd
  • [ ] hoe kan ik een release doen?
    • [ ] wanneer schrijf ik een changeset? welke dingen moeten er in? typo's? Wat is voor documentatie de verdeling tussen geen release/patch/minor/major?
    • [ ] link naar: hoe schrijf ik een changeset / welke npm packages moet ik aanvinken?
    • [ ] hoe werkt de Pull Request voor een release doen?
• [ ] Hoe schrijf ik de codevoorbeelden met een <Guidelines> en <Canvas> of met Markdown?

Deze plaatsen we in de README.md van de documentatie repo

[Robbert]

Feedback van Rian was: de medium prio dingen hebben voor het huidige team geen prioriteit, we kunnen onze tijd beter besteden aan andere dingen.

Mijn take: laten we die meidum dingen oppakken wanneer het documentatie-team wordt uitgebreid.