Quote:
Originally Posted by Halo
I will be working on improving calibre's documentation during the next six months, mainly as an effort to "scratch my own itch." I like to take notes when I learn things and calibre's open-source nature allows me to channel what I learn back into the official documentation.
I would like to hear from other users, particularly non-technical users, about which areas of calibre need to be better documented. I will do my best to improve those areas of the documentation.
- Is there an area of calibre that is poorly documented or not documented at all?
- Are there explanations in the documentation that are too complex or simple?
- Do you want more screenshots?
- Would tutorials and walk-throughs help?
- Etcetera...
Please note: I don't intend for this thread to be a place to find help about an issue you have with calibre. It's also not the right place to discuss making calibre's user interface more intuitive. I merely want to document the program as it exists right now and use this thread as a to-do list as I work on the docs. Also, don't expect improvements overnight. I'm doing this in my spare time as I learn and explore all the facets of the program. |
I find the organization hard to deal with (and I am
of an example of the best users guide to compare to. Later, when I remember
).
1) Label all topic sections Basic or Advanced. Provide a 'Hide Advanced (body only, so they can tell there is more...)' (use a cookie to remember button state)
2) One topic per page (KIS (visually) as to not overwhelm), with a see also section at the foot for commonly related items. Ex getting books onto your device: You have 3 different methods, with control options that are related.
3) lots of examples (cut and paste code snippets
)