Ask HN: How do you document engineering efforts?

• documentation-framework

  54 89 5.2 Python

  "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework

  

I really like the system detailed here: https://documentation.divio.com/. That's targeted more towards externally visible docs, but IMO adapts pretty well as for internal resources too.

• madr

  6 1,347 6.8

  Markdown Architectural Decision Records

  

MADR [1] in its reframed "Any Decision Record" form can be a good tool for that. RFDs [2] also appear to capture a similar intent.

[1]: https://adr.github.io/madr/

[2]: https://rfd.shared.oxide.computer/rfd/0001

• InfluxDB

  www.influxdata.com featured

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project