Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
GOV.UK developer docs
Search
Tijmen Brommet
November 20, 2017
Programming
0
510
GOV.UK developer docs
https://skillsmatter.com/skillscasts/11153-5-ways-to-keep-docs-up-to-date
Tijmen Brommet
November 20, 2017
Tweet
Share
More Decks by Tijmen Brommet
See All by Tijmen Brommet
Reuse your government's code
tijmenb
0
460
Other Decks in Programming
See All in Programming
なぜ「共通化」を考え、失敗を繰り返すのか
rinchoku
1
630
「Cursor/Devin全社導入の理想と現実」のその後
saitoryc
0
700
技術同人誌をMCP Serverにしてみた
74th
1
580
Blazing Fast UI Development with Compose Hot Reload (droidcon New York 2025)
zsmb
1
280
Rubyでやりたい駆動開発 / Ruby driven development
chobishiba
1
570
プロダクト志向なエンジニアがもう一歩先の価値を目指すために意識したこと
nealle
0
120
Systèmes distribués, pour le meilleur et pour le pire - BreizhCamp 2025 - Conférence
slecache
0
120
PHP 8.4の新機能「プロパティフック」から学ぶオブジェクト指向設計とリスコフの置換原則
kentaroutakeda
2
730
ペアプロ × 生成AI 現場での実践と課題について / generative-ai-in-pair-programming
codmoninc
1
6.6k
WindowInsetsだってテストしたい
ryunen344
1
230
Cursor AI Agentと伴走する アプリケーションの高速リプレイス
daisuketakeda
1
130
Porting a visionOS App to Android XR
akkeylab
0
220
Featured
See All Featured
GraphQLとの向き合い方2022年版
quramy
49
14k
How STYLIGHT went responsive
nonsquared
100
5.6k
We Have a Design System, Now What?
morganepeng
53
7.7k
Being A Developer After 40
akosma
90
590k
Build your cross-platform service in a week with App Engine
jlugia
231
18k
For a Future-Friendly Web
brad_frost
179
9.8k
Learning to Love Humans: Emotional Interface Design
aarron
273
40k
Making Projects Easy
brettharned
116
6.3k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
667
120k
Java REST API Framework Comparison - PWX 2021
mraible
31
8.7k
Designing Experiences People Love
moore
142
24k
Transcript
Tijmen Brommet Lead developer, GOV.UK Government Digital Service @tijmenbr
2 GOV.UK's internal developer docs
3 GDS
4 GDS
5 GDS
6 GDS
7 GDS
8 GDS 2012: live 2013: + departments 2014: + agencies
9 GDS
10 GDS Result: size & complexity make it hard to
learn
11 Why is documentation so hard?
12 GDS Nobody reads the docs Nobody keeps docs up
to date Docs are out of date Nobody trusts the docs
13 GDS How? 1. Make it fun to update 2.
Make it easy to find 3. Optimise reading & writing 4. Integrate data & config 5. Keep it up to date
14 1. Make it fun to update
15 GDS
16 GDS
17 GDS
18 GDS
19 GDS
20 GDS
21 2. Make it easy to find
22 GDS Before: [REDACTED]
23 GDS
24 GDS
25 GDS
26 GDS
27 GDS
28 GDS
29 3. Optimise reading & writing
30 GDS
31 GDS
32 GDS
33 GDS <%= HTTP.get('https:// raw.githubusercontent.com/alphagov/ publishing-api/master/doc/api.md') %>
34 GDS
35 4. Integrate data & config
36 GDS
37 GDS
38 GDS
39 GDS
40 5. Keep it up to date
41 GDS Is this accurate? ¯\_(ϑ)_/¯
42 GDS
43 GDS Date of last review & owner
44 GDS
45 GDS
46 GDS
47 GDS
48 GDS This is a text slide
GDS This is a text slide
50 GDS Before: 352 commits by 39 authors After: 964
commits by 54 authors
51 Summary
52 GDS 1. Make it fun to update 2. Make
it easy to find 3. Optimise reading & writing 4. Integrate data & config 5. Keep it up to date (with a guard dog)
53 GDS Nobody reads the docs Nobody keeps docs up
to date Docs are out of date Nobody trusts the docs
54 GDS People use docs every day Docs are kept
up to date Docs are mostly accurate People trust docs
55 GDS docs.publishing.service.gov.uk github.com/alphagov/govuk-developer-docs
56 GDS Thank you! @tijmenbr
57 Secret bonus content
58 GDS
59 GDS
60 GDS
61 GDS