Skip to content

Algemene aanpak voor herbruikbare stories #3697

@Yolijn

Description

@Yolijn

Er is vanuit verschillende organisaties behoefte om documentatie rondom Stories te kunnen hergebruiken wanneer een component van een andere organisatie wordt toegevoegd aan een design system.

In de Candidate repository is een aanpak gekozen die zorgt dat de documentatie wordt hergebruikt in de verschillende Candidate storybooks https://github.com/nl-design-system/candidate/milestone/11. Door deze aanpak te valideren, en daarna te documenteren kan deze ook door andere organisaties in de community gebruikt worden.

Acties

  • Valideer of de aanpak die is gekozen aansluit bij de behoefte in dit issue van de Rijkshuisstijl community Standaardiseren storybook docs markdown rijkshuisstijl-community#1620
  • Valideer of de documentatie van de Candidate componente kan worden hergebruikt in de Rijkshuisstijl community
  • Documenteer de aanpak voor op nldesignsystem.nl/handboek/developers/...

Acceptatiecriteria

  • Er is een aanpak voor het beschikbaar maken van herbruikbare component documentatie
  • Deze documentatie kan makkelijk worden hergebruikt in Storybook
  • Deze documentatie kan makkelijk worden hergebruikt in een andere Markdown zoals op nldesignsystem.nl of in de nieuwe design system website van Utrecht op basis van Astro
  • De aanpak is gedocumenteerd op de website
  • De documentatie is gevalideerd met developers in de community

Metadata

Metadata

Assignees

Type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions