alphagov / design-system-team-docs

Documentation for the design system team – what we do, how we work, etc.
https://team-playbook.design-system.service.gov.uk/
4 stars 2 forks source link
govuk-design-system-team

GOV.UK Design System Team Docs

⚠️ This is for internal use by the Design System team. Public-facing documentation can be found at https://design-system.service.gov.uk.

A reference guide for who we are and the way we do things. It's a playbook for anyone in the GOV.UK Design System team that tells us the 'right way' to do things.

What's written here is the way we do things now, but that will change from time to time.

View the playbook at https://team-playbook.design-system.service.gov.uk/

Technologies

The docs were built using the Tech Docs Template, which uses Tech Docs Gem version 3.3.1.

Setup

Run bundle install to update dependencies, then run bundle exec middleman server to run the local server.

Contributing

Contributions from the team are always welcome! This playbook is currently in alpha, meaning we're testing out what content and guidance is useful. Raising issues and pull requests is strongly encouraged, so that we can develop the playbook as a team.

We continually update this playbook because we're always looking for better ways to get things done. And that changes over time, especially as who works on the team and what we work on changes too.

See contributing.md for ways to get started.

Acknowledgements

This guide was inspired by dxw's Playbook.

License

Needs adding, but either OGL or MIT.