Bug 308697

Translating the KRecipes documentation (27% done, don’t intent to continue for now), I’ve not only find some errors, but also things that I think should be improved. It looks to me like the documentation needs a complete review by one of its developers or anyone else with experience using this application.

Some things to consider:
- There are a lot of parts in the documentation with too much text, or things that are repeated over and over. Documentation is already boring by nature, so the less we can do is to make it the shorter it can be (without lacking documentation).
- In http://docs.kde.org/development/en/extragear-utils/krecipes/enter-edit-recipes.html#ingredients-tab , under Looking After Nutrients, the screenshot does not match the documentation below. The documentation explains what is happening in the screenshot, but the information just does not match. Maybe the screenshot was updated with a different content and the documentation around was not updated accordingly.
- The screenshots are certainly outdated. For example, see the first image in the page linked above. The button around the recipe image (chef tux) are in the latest version of KRecipes placed below the image, not at its right side.
- I am no expert in English, certainly not a native speaker, but I see an usage of the dash (—) that I had never seen before: in circumstances where I usually see a colon (:). I guess the documentation was not written by a native speaker either, since that is not the only “weird” thing I found.

Also, if the documentation is in fact reviewed as a whole, maybe you should consider porting it to KDE Userbase. You should be able to talk to the Amarok team for information on how to do that. In the end, it would make the documentation easier to maintain, since anyone could fix issues like the screenshot ones I mentioned earlier, without the need to download the code, build the documentation and then send a patch for review. Being documentation as it is the most boring part (for most people, anyway) of software development, the less you can do is to make it easy for people to contribute to it.

Reproducible: Always