Date: Wed, 6 Aug 2014 22:48:30 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: Paul Kraus <paul@kraus-haus.org> Cc: Polytropon <freebsd@edvax.de>, FreeBSD Questions !!!! <freebsd-questions@freebsd.org> Subject: Re: Documentation WAS: pkg question .... Message-ID: <alpine.BSF.2.11.1408062223080.94639@wonkity.com> In-Reply-To: <10FF0A4F-F96E-4A68-BA25-56B57AFD4B2E@kraus-haus.org> References: <53E0D2B7.9060402@hiwaay.net> <20140805131910.GA72939@slackbox.erewhon.home> <53E0E281.9030306@hiwaay.net> <20140805225107.ccf9944a.freebsd@edvax.de> <10FF0A4F-F96E-4A68-BA25-56B57AFD4B2E@kraus-haus.org>
next in thread | previous in thread | raw e-mail | index | archive | help
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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.11.1408062223080.94639>