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
チームで開発し事業を加速するための"良い"設計の考え方 @ サポーターズCoLab 2025-07-08
agatan
0
230
第9回 情シス転職ミートアップ 株式会社IVRy(アイブリー)の紹介
ivry_presentationmaterials
1
280
なぜ「共通化」を考え、失敗を繰り返すのか
rinchoku
1
640
Goで作る、開発・CI環境
sin392
0
220
来たるべき 8.0 に備えて React 19 新機能と React Router 固有機能の取捨選択とすり合わせを考える
oukayuka
2
910
PostgreSQLのRow Level SecurityをPHPのORMで扱う Eloquent vs Doctrine #phpcon #track2
77web
2
500
AIプログラマーDevinは PHPerの夢を見るか?
shinyasaita
1
200
イベントストーミング図からコードへの変換手順 / Procedure for Converting Event Storming Diagrams to Code
nrslib
2
640
今ならAmazon ECSのサービス間通信をどう選ぶか / Selection of ECS Interservice Communication 2025
tkikuc
21
3.9k
技術同人誌をMCP Serverにしてみた
74th
1
630
なぜ適用するか、移行して理解するClean Architecture 〜構造を超えて設計を継承する〜 / Why Apply, Migrate and Understand Clean Architecture - Inherit Design Beyond Structure
seike460
PRO
3
750
初学者でも今すぐできる、Claude Codeの生産性を10倍上げるTips
s4yuba
16
10k
Featured
See All Featured
Making Projects Easy
brettharned
116
6.3k
GitHub's CSS Performance
jonrohan
1031
460k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
20
1.3k
YesSQL, Process and Tooling at Scale
rocio
173
14k
Building Adaptive Systems
keathley
43
2.6k
The Art of Programming - Codeland 2020
erikaheidi
54
13k
Building Applications with DynamoDB
mza
95
6.5k
Building Flexible Design Systems
yeseniaperezcruz
328
39k
Designing for humans not robots
tammielis
253
25k
Build your cross-platform service in a week with App Engine
jlugia
231
18k
Being A Developer After 40
akosma
90
590k
GraphQLとの向き合い方2022年版
quramy
49
14k
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