mikelove said:
HW60 said:
Instruction Manual / Flashcard Reference / Test Interface and then your hint: "tap on a word to select it, then tap on the > button to bring up a dictionary definition screen for it."
viewtopic.php?f=20&t=2823&p=25820#p25830
HW60 said:
As for the Instruction Manual I have a suggestion: I often scroll through the text of the Manual, trying to find something. Then when I find a heading like "Interface" and try do follow the instructions, I do not know where I am: Dictionary, Flashcards, where at all? I suggest to add some more information to some of the headings, in the example for instance
That whole thing needs to be reorganized, really - we're trying to find some good documentation generation software that we can use to easily make desktop / tablet / mobile / PDF / etc versions from the same source data.
Based on a quick scan of your docs, here are some suggestions from a technical editor who has worked on a ton of handbooks for commercial software:
[*]Avoid words like "Basic" and "Advanced" as headings. They are nebulous and arbitrary and they don't give the user any clue as to how the information is really organized. It's especially weird when you have some of the "Search" help in basic and some in advanced. As a user that makes no sense at all.
[*]Provide better navigation. For example, a list of links at the top of the tutorials page would be better than forcing the reader to scroll down through everything to find (maybe) the information they're looking for.
[*] Use more bulleted lists or, for sequential information like the steps in a procedure, use numbered lists.
[*] Use consistent headings. Right now, the headings are a bit of a mishmash of styles. Generally speaking, in tech writing you should use something like "Search a dictionary" or "To search a dictionary" for specific procedures and gerunds (searching, writing, making etc) should be used for higher level headings like "Using dictionaries".
[*} Try to make the headings task-focused rather than UI-focused. For example, rather than "Stroke Order Diagrams", maybe something like "View stroke order".
[*]Your "Reference" section is seriously misnamed since it seems to contain mostly procedural information. Reference material is typically stuff like lists of acronyms or maybe background technical information.