[Nix-dev] Real documentation, aka "Let's kill the wiki"

Profpatsch mail at profpatsch.de
Sat Nov 21 21:21:34 CET 2015


On 15-11-19 05:17pm, Cillian de Róiste wrote:
> 2015-11-19 16:57 GMT+01:00 Profpatsch <mail at profpatsch.de>:
> > On 15-11-19 02:56am, Roger Qiu wrote:
> > May I humbly suggest http://stevelosh.com/blog/2013/09/teach-dont-tell/ as
> > a general documentation writing template?
> 
> I'm a big fan of https://jacobian.org/writing/great-documentation/

Yes, that’s what sjl references in the prior reading section as well.
These two are basically the technical writing 101 everyone should know.

-- 
Proudly written in Mutt with Vim on NixOS.
Q: Why is this email five sentences or less?
A: http://five.sentenc.es
May take up to five days to read your message. If it’s urgent, call me.


More information about the nix-dev mailing list