~/talk

Documenting the (Ancient) History of Your Project

Talkat Write the Docs Prague 2020 · 2020-10-18..10-20· [developer-experience]
slides:none on file

Argument: record decision subject line and body in every commit and wrap bodies to 72 columns so later readers can digest why changes happen. Use the git pickaxe (not just git blame) to find the commit that explains the why and include metadata and diffs. Add a project-level decisions_context file for major events (language migration, team ownership changes, business deadlines) and reference those records from READMEs and contributing pages so context stays discoverable.

AI-written summary · about

  1. 0:00Introduction
  2. 5:46Examples
  3. 7:28What is Archaeology
  4. 9:45Archaeology and Technical Documentation
  5. 12:04Context and Documentation
  6. 13:13Commit Messages
  7. 15:17Documentation Structure
  8. 19:47Timing and Nuance
  9. 22:35Summary
  10. 24:47Resources
  11. 25:16Career Switch
  12. 27:20Questions
~/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.