@coderbyheart on Twitter

Home / Archive / 2020 / 2020-09 / 1307268508208762883

The second #testcraftcamp session was about which kind of documentation supports
testing, and it turned into a great exchange about documentation in general,
weather it's needed at all, ...

In the end there is no one-size-fits-all solution when it comes to
documentation:

Sat, 19 Sep 2020 10:41:14 UTC♥ 6↻ 1

2 replies

Replying to @coderbyheart

In my experience:

BDD (https://de.wikipedia.org/wiki/Behavior_Driven_Development) is great,
ties documentation to test directly
use ADRs
(https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
to document history of project (really helps to understand what influenced
current state of project)

Sat, 19 Sep 2020 10:41:15 UTC♥ 4↻ 1

Replying to @coderbyheart

use living documentation platform (wiki) that allows feedback and continuous
improvement - they suck however when it comes to keeping them relevant
(/status/1303990376756326400)
record videos of explaining certain aspects of the stack is great to transmit
your mindset

Sat, 19 Sep 2020 10:41:15 UTC