Simon Willison’s Weblog

Subscribe

Saturday, 3rd August 2019

Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference. Each of them requires a distinct mode of writing. People working with software need these four different kinds of documentation at different times, in different circumstances - so software usually needs them all.

Daniele Procida

# 8:29 am / documentation, diataxis

Logs vs. metrics: a false dichotomy (via) Nick Stenning discusses the differences between logs and metrics: most notably that metrics can be derived from logs but logs cannot be reconstituted starting with time-series metrics.

# 4:46 pm / observability, logging

2019 » August

MTWTFSS
   1234
567891011
12131415161718
19202122232425
262728293031