lilypond-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Pictures in the docs and website


From: Jan Nieuwenhuizen
Subject: Re: Pictures in the docs and website
Date: Tue, 26 Feb 2013 07:59:28 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.1 (gnu/linux)

Graham Percival writes:

> No argument there!  Yes, more documentation about maintainability
> the better.

I hope you're joking...  The less documentation needed, whether it be
for program usage, describing program bugs, build or release process, or
maintainability, the better.  No one likes to read documentation.

What is really bad, is a situation where doing one of these things
becomes some sort of puzzle, maze, time sink of trial and error, that
could have been avoided by adding or sharing some minimal piece of
documentation.

However, documenting something that can also be automated is bad.
Fixing a bug is much better than adding documentation about how to work
around it.  If you are tempted to document something, start with /why/

Greetings,
Jan

-- 
Jan Nieuwenhuizen <address@hidden> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | AvatarĀ®  http://AvatarAcademy.nl  



reply via email to

[Prev in Thread] Current Thread [Next in Thread]