Adding documentation using manpages to the manifesto. - bitreich-documents - The repository to track the core bitreich documents.
HTML git clone git://bitreich.org/bitreich-documents/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/bitreich-documents/
DIR Log
DIR Files
DIR Refs
DIR Tags
---
DIR commit bfee9fcd36476cc540c704cb6421021f1e25277e
DIR parent 56ab7788dc77adf357e2d2bfb0e097a688f62470
HTML Author: Christoph Lohmann <20h@r-36.net>
Date: Tue, 30 Jan 2018 12:00:43 +0000
Adding documentation using manpages to the manifesto.
The addition of this paragraph was decided by the council on 2018-01-30.
Diffstat:
M bitreich-manifesto.md | 8 ++++++++
1 file changed, 8 insertions(+), 0 deletions(-)
---
DIR diff --git a/bitreich-manifesto.md b/bitreich-manifesto.md
@@ -82,6 +82,14 @@ erything needs to be present. This is subject-oriented programming.
Bugtrackers are obsolete. Whenever you find a bug, fix it. The other
principles make it possible for you to send a patch instead of a report.
+#### Straightforward Documentation
+
+There are all kind of tools like javadoc, info etc. which fragment the
+way to find useful information. All software should provide manpages. If
+you need more features than manpages require, rethink what you are try‐
+ing to document. Manpages have a well‐defined structure which makes
+finding and extracting the required information easier and uniform.
+
#### Applications Can Be Done
When a project solves a problem, keep it done and declare it so. New