Keeping tech docs up to date with Daniel the Manual Spaniel
GDS uses the doc-as-code approach to technical documentation, but keeping that content up to date is more of a challenge. Here’s how GDS technical writers and developers fixed the issue.
GDS uses the doc-as-code approach to technical documentation, but keeping that content up to date is more of a challenge. Here’s how GDS technical writers and developers fixed the issue.
On the GOV.UK team, all our changes are peer reviewed using Github's pull request system. If a developer wants to make a change to one of our projects, they need another developer’s approval before the change is accepted into the …
...and API iteration. In comparison, the (roughly) representational state transfer (RESTful) JavaScript Object Notation (JSON) APIs we’ve been developing over the last few years are simple and clear, but lack...
Other teams around government frequently ask us about our use of GitHub, and rather than bury those answers in email it seemed time to follow Mike Bracken’s directive and publish (not send) our answers. I’ve made some assumptions here about …