https://skillsmatter.com/skillscasts/11153-5-ways-to-keep-docs-up-to-date
Tijmen BrommetLead developer, GOV.UK Government Digital Service @tijmenbr
View Slide
2GOV.UK's internal developer docs
3GDS
4GDS
5GDS
6GDS
7GDS
8GDS2012: live2013: + departments2014: + agencies
9GDS
10GDSResult: size & complexity make it hard tolearn
11Why isdocumentation sohard?
12GDSNobody readsthe docsNobody keeps docsup to dateDocs areout of dateNobody truststhe docs
13GDSHow?1. Make it fun to update2. Make it easy to find3. Optimise reading & writing4. Integrate data & config5. Keep it up to date
141. Make it fun to update
15GDS
16GDS
17GDS
18GDS
19GDS
20GDS
212. Make it easy to find
22GDSBefore:[REDACTED]
23GDS
24GDS
25GDS
26GDS
27GDS
28GDS
293. Optimise reading & writing
30GDS
31GDS
32GDS
33GDSraw.githubusercontent.com/alphagov/publishing-api/master/doc/api.md') %>
34GDS
354. Integrate data & config
36GDS
37GDS
38GDS
39GDS
405. Keep it up to date
41GDSIs this accurate?¯\_(ϑ)_/¯
42GDS
43GDSDate oflast review &owner
44GDS
45GDS
46GDS
47GDS
48GDSThis is a text slide
GDSThis is a text slide
50GDSBefore: 352 commits by 39 authorsAfter: 964 commits by 54 authors
51Summary
52GDS1. Make it fun to update2. Make it easy to find3. Optimise reading & writing4. Integrate data & config5. Keep it up to date (with a guard dog)
53GDSNobody readsthe docsNobody keeps docsup to dateDocs areout of dateNobody truststhe docs
54GDSPeople use docsevery dayDocs are keptup to dateDocs aremostly accuratePeople trustdocs
55GDSdocs.publishing.service.gov.ukgithub.com/alphagov/govuk-developer-docs
56GDSThank you!@tijmenbr
57Secret bonus content
58GDS
59GDS
60GDS
61GDS