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

Profpatsch mail at profpatsch.de
Thu Nov 19 16:57:31 CET 2015


On 15-11-19 02:56am, Roger Qiu wrote:
> Can the manual be made as a gitbook with the chapters fleshed out better
> and made more user friendly? One  part of the manual can be very fact
> based, another part can be story based. Kind of like the difference between
> documentation vs api documentation vs tutorials. I often find myself across
> 3 to 4 different blog posts, the arch and gentoo wiki, the nixos manual,
> the wiki and github issues because the up to date relevant information is
> everywhere.

May I humbly suggest http://stevelosh.com/blog/2013/09/teach-dont-tell/ as
a general documentation writing template?

-- 
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