From 4df6ef4a8e3d2893429da0c24576c334e1dee4f2 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Fri, 23 Oct 2020 09:18:30 +0300 Subject: doc: add requirement for excellent documentation --- obnam.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'obnam.md') 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 -- cgit v1.2.1