summaryrefslogtreecommitdiff
path: root/obnam.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2020-10-23 09:18:30 +0300
committerLars Wirzenius <liw@liw.fi>2020-10-23 09:18:30 +0300
commit4df6ef4a8e3d2893429da0c24576c334e1dee4f2 (patch)
tree6e35c71b33c0c5352c1a2356b6caf946705828ed /obnam.md
parentedc685a589a2e92b375370b00a525b4c53f71525 (diff)
downloadobnam2-4df6ef4a8e3d2893429da0c24576c334e1dee4f2.tar.gz
doc: add requirement for excellent documentation
Diffstat (limited to 'obnam.md')
-rw-r--r--obnam.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/obnam.md b/obnam.md
index 5cd5b58..fc11488 100644
--- a/obnam.md
+++ b/obnam.md
@@ -49,6 +49,10 @@ in an automated way:
* _Not done:_ **Easy to configure:** only need to configure things
that are inherently specific to a client, when sensible defaults are
impossible.
+* _Not done:_ **Excellent documentation:** although software ideally
+ does not need documentation, in practice is usually does, and Obnam
+ should have documentation that is clear, correct, helpful,
+ unambiguous, and well-liked.
* _Not done:_ **Easy to run:** making a backup is a single command
line that's always the same.
* _Not done:_ **Detects corruption:** if a file in the repository is