3 ms·
whats the rationale for writing technical documentation like its a series of casual text messages
by jonathrg 3y ago
whats the rationale for writing technical documentation like its a series of casual text messages
- serf 3y agomaybe they're trying to entice someone with keen documentation knowledge to their project by means of git collaboration? hint hint.
- jonathrg 3y agoNo, I think it's written like that on purpose.
- psd1 3y agoI'll bite! Same as event sourcing - it's thread-safe. I find, when updating docs, that is easy to miss a paragraph and leave obsolete info. Then you have invalid state. If you merely post updates, then accurate state can always be reconstructed by replaying the log. The cost is that replaying is more expensive. Likewise, if you're busy, it might suit you to chuck an update at the doc rather than take care over it. It's probably not so good for the doc, but better than not updating the doc. Startup mentality <taps head>