Documentation WAS: pkg question ....
wblock at wonkity.com
Thu Aug 7 04:48:42 UTC 2014
On Wed, 6 Aug 2014, Paul Kraus wrote:
> I understand that developers want to develop and not write manuals.
Documentation should be seen as part of developing. It is not an
optional extra. A program without documents is incomplete.
Documentation does not have to be perfect, any more than the program
itself. But it should answer the basic questions:
What is this?
What are the requirements?
How is it used?
In that last part: good, useful examples can make the difference between
a successful application and one that is abandoned because people can't
figure out how make it work.
Finally, FreeBSD developers and users should be aware that the FreeBSD
documentation team can provide assistance with creating man pages or
DocBook documentation like the Handbook. People interested in that help
can post on the freebsd-doc mailing list.
More information about the freebsd-questions