 |
Adding documentation using manpages to the manifesto. - bitreich-documents - Th… |
 |
git clone git://bitreich.org/bitreich-documents/ git://enlrupgkhuxnvlhsf6lc3fzi… |
 |
Log |
|
Files |
|
Refs |
|
Tags |
|
--- |
|
commit bfee9fcd36476cc540c704cb6421021f1e25277e |
|
parent 56ab7788dc77adf357e2d2bfb0e097a688f62470 |
|
Author: Christoph Lohmann <[email protected]> |
|
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(-) |
|
--- |
|
diff --git a/bitreich-manifesto.md b/bitreich-manifesto.md |
|
@@ -82,6 +82,14 @@ erything needs to be present. This is subject-oriented progr… |
|
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 |
