~/talk

Developers Documentation: your secret weapon

Talkat apidays Hong Kong 2022 · 2022-08-24..08-25· [documentation]
links:none on file
slides:none on file

Developer documentation must be an integral part of the product and drives adoption by earning developer love through clear entry, intermediate and advanced paths. Practical steps include adding a fast search bar, keeping code examples runnable and current, using responsive, low-latency hosts (GitBook/WordPress or SaaS), including focused screenshots with obfuscation tricks, enforcing regular peer review, and dedicating one or two people to iterate quickly and push docs early then update based on real user questions.

AI-written summary · about

  1. 0:00Start
  2. 4:33Tips and Tricks How To Have a Better Development Document Management
  3. 6:09The Content Structure
  4. 8:23Screenshots
  5. 11:27Containers
~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.