Hey Torsten,
Minimalism is a basic tenant of technical writing. We should strive to
convey the "thing" in question using the fewest words and image to (1)
reduce the maintenance overhead and (2) more words/images generally do
not make the "thing" clearer, in fact, quite the opposite. It often
muddies the picture.
The current documentation has a colloquial verbosity to it that (I feel)
doesn't enhance the understanding of the reader. Similarly, there are
images that don't enhance the readers understand either, for instance in
the current documentation there is a image of every since module just
ahead of the textual description of that module. In the new docs, we've
split out module references into their own section and we assume you
have darktable open in front of you (or you know what a module generally
looks like) and thus we omit the image.
If there are specific instances where you think not enough is written,
you are encouraged to open an issue.
Hope that makes sense.
-mica
On 10/18/20 7:18 PM, Torsten Bronger wrote:
Hallöchen!
A question from a prospective reader rather than author: Why do you
want to keep the number of words and images to a minimum? FWIW, I
find both very helpful when reading about complex matters.
Regards,
Torsten.
___________________________________________________________________________
darktable developer mailing list
to unsubscribe send a mail to darktable-dev+unsubscr...@lists.darktable.org
