Improvement Suggestions

[raublekick (Andrew Raub)]

@paperdigits

But if the user wishes to remain nontechnical, should we continue to expend effort to appease them? If yes where do we stop?

As a software developer myself, I can confidently say that software development would be a lot easier without the users

@elstoc

We are very open to discussing clearer wording if people can suggest something that is better (and still demonstrably correct) but this is very hard to do while also keeping the manual an objective and accurate description of how the software functions.

I took a quick glance at the diffuse or sharpen module docs and I think there’s a few things that could be improved. The documentation starts off with defining what diffusion is, and there’s considerable technical documentation before it gets to workflow and suggesting to start with presets. Some possible improvements:

• Start with a general description of what the module does, similar to the docs for other modules. Something like: The diffuse or sharpen module can apply a variety of effects such as diffusion, blurring, local contrast, and sharpening. Included are a variety of presets which can be used to quickly and easily apply these effects.
• Next could be the “starting with presets” section
• Follow this with an “advanced usage” section (i.e. the starting from scratch section) that sets the stage for the rest of the technical documentation that exists.

It might be nice for the modules to have a documentation template to follow so there’s a consistent layout and order of information. There could even be a table of contents on each page if the templating engine used allows anchor links within a page. I have some more general ideas too that I’d be happy to share.