API documentation team capabilities

1 votes

Changes to NHS Digital team structures to ensure teams have the skills they need to produce consistently good quality documentation.

Done make-learning-easier platform-phase-2 Suggested by: Tony Heap (11 Jul, '20) • Upvoted: 22 Jul, '20 • Comments: 3

Comments: 3

11 Jul, '20
Tony Heap Admin Merged
Guidance for our API producer teams on how to write API specifications and other documentation to our house style.
20 Jul, '20
Tony Heap Admin
"Documentation style guide" (suggested by API Management Team on 2020-07-11), including upvotes (1) and comments (0), was merged into this suggestion.
05 Jul, '21
Tony Heap Admin
This work is now done - we have agreed our operating model for tech authors - in short we expect API producers to write their own API documentation, but we have (a) provided good guidance on how to do that in our internal API producer documentation in Confluence; (b) provided the PDS FHIR API specification as an exemplar; (c) set up a small central team of tech authors to support API producers and (d) agreed to allocate a dedicated tech author to each API producer team as a point of contact.