Go back

Contributing to the playbook

Vision

The playbook holds information about how we design, build and run services in the NHSBSA so that people know what to do while working here.

Principles

It is open. The articles are stored in an open source repository, and published on the internet without any access protection. Anyone can read it.

It is specific to how we work at the NHSBSA, but general enough to apply across different services.

It is readable, like a book but also as a reference. Articles should stand alone and convey enough valuable information to be worthwhile.

Users

We should consider these core users when writing content:

  • NHSBSA Staff (Digital, Data and Technology): The people who deliver our services
  • External suppliers: The people we entrust to deliver services on our behalf
  • Cross Government agencies and organisations: Experts in relevant professions who can help us to improve

What should be included in the playbook?

  • Standards
    To define our requirements in service delivery.
  • Guides
    To explain how to do things at the NHSBSA.
  • Tool choices
    To clarify our preferred toolset so we don’t waste time researching multiple times, or diverge too far across our services.
  • Links
    We link to existing guidance where appropriate. E.g. UK Government, NHS, NCSC and worldwide SME authorities such as OWASP.
    We avoid linking to other organisations where the content is specific to them.

What shouldn’t be in the playbook?

  • Confidential information
    This includes Personally Identifiable Information such as names and email addresses
    Provide links to confidential content on the NHSBSA intranet (The Hub)
  • Project specific information
    Every project team maintains their own project documentation. This is not that.
  • In depth analysis and decision logs
    The playbook contains how we do things, now. It doesn’t need to say how we got there.

How do I decide?

Follow our suggest a change guide that explains how we use Github Discussions to discuss whether content should be added to the playbook.

For more detail on how to contribute to the playbook, read these articles:

Improve the playbook

If you spot anything factually incorrect with this page or have ideas for improvement, please share your suggestions.

Before you start, you will need a GitHub account. Github is an open forum where we collect feedback.

Suggest a change to this page

Published: