Establish a process for improving the quality of our design system documentation, using the component documentation content pattern as a guide.
The process should include a cross-functional content review that is a weekly standing invite for the entire team to attend. The process should not be reliant on a single person, and should encourage the sentiment that it is the responsibility of the whole team to improve the quality of our documentation. The initial goal should be to get all the components to a state in which they are following a standard format, utilizing the component documentation pattern document. We will then progress with a continuous improvement model to update and iterate our documentation so that it is useful and accurate for our users.
Why
To improve the quality and consistency of our design system documentation. By establishing a process for improving our documentation so that we can ensure that Elements is accurate, up-to-date, and easy to use for designers and developers. This will result in a more efficient design and development process, as well as a better user experience for our end-users.
Objectives:
To establish a process or framework for improving the quality of our design system documentation
To ensure that our components are well documented using the component documentation pattern
To encourage a culture of continuous improvement for our design system documentation
To involve the entire team in the documentation improvement process
Done when
Acceptance criteria:
A process for improving the quality of our design system documentation is established and documented
The process includes a weekly standing invite for a cross-functional content review
The process is not reliant on a single person and is the responsibility of the entire team
The team has identified and completed at least one improvement to our design system documentation using the process or framework
What
Establish a process for improving the quality of our design system documentation, using the component documentation content pattern as a guide.
The process should include a cross-functional content review that is a weekly standing invite for the entire team to attend. The process should not be reliant on a single person, and should encourage the sentiment that it is the responsibility of the whole team to improve the quality of our documentation. The initial goal should be to get all the components to a state in which they are following a standard format, utilizing the component documentation pattern document. We will then progress with a continuous improvement model to update and iterate our documentation so that it is useful and accurate for our users.
Why
To improve the quality and consistency of our design system documentation. By establishing a process for improving our documentation so that we can ensure that Elements is accurate, up-to-date, and easy to use for designers and developers. This will result in a more efficient design and development process, as well as a better user experience for our end-users.
Objectives:
Done when
Acceptance criteria:
Anything else
Component documentation content patter. Example of an incomplete component documentation page. Example of a component page that maps to the documentation content pattern.