Topic: Reference Manual versus User Guide

Viewing 3 posts - 1 through 3 (of 3 total)
  • #2453
    mikeparr
    Participant

    I’m a newbie of 2 weeks standing, but am managing to create music. (At present using the free version – sorry!)

    I’m not complaining here, so don’t take this the wrong way! I think it is a great product, and I will stick with it.

    I’ve found it heavy going in some areas, and some of this is due to the guide. In one sense it is well-written (accurate, unambiguous), but not quite what novice users want imho (in spite of the Getting Started section).

    From my own subject area (writer of programming texts) it is the difference between:

    – ‘The XYZ Programmers Reference’

    – ‘Learn to program in XYZ’

    Here is an example. P62 says:

    ‘Clicking on an already selected event will only deselect other events
    when you release the button. This allows you to click on a multiple event selection and drag
    them to a new position. Ctrl+clicking an event will toggle selection of that event and preserve
    selections of other events.’

    This is correct, yes? And covers every case, Yes?

    But what I needed was:

    ‘To make a multiple selection, hold the ctrl key and click on some events.’

    This doesn’t exactly cover every case (when the first selection is selected already – but that is visually apparent) but it is clearer, I suggest.

    I plan to do some simple videos (more basic than the current ones), but wondered if other users thought that an extensive ‘How Do I…’ section in the user-edited wiki would be worthwhile.

    #19909
    thcilnnahoj
    Participant

    Constructive criticism is always welcome, don’t worry!

    The guide has actually undergone a big update this year. You have to know that it was hopelessly out-of-date on most things before… I’ve also been helping out with rewriting a few chapters (not the one you mentioned in particular, though) during this time, but I tried not to change the writing style.

    As there is nobody who looks after the guide full-time, any rewriting would have to be done by Frits, meaning less time to develop Podium (I also don’t have too much time these days, sorry).

    I’m not sure what it is exactly you’re suggesting, but I’m sure Frits wouldn’t mind if you yourself made modifications to the guide that make it easier to understand, or more complete. 😉

    #19946
    Zynewave
    Keymaster

    Hi Mike,

    I agree that the Podium guide is written more as a reference guide than an introduction for newbies. Writing it as a reference is the quickest way for me to document features, so that at least I’m not the only one in the world that are aware of how to use certain features. If you want to change something in the Podium guide, you can do that on the wiki site. The Podium pdf guide is printed from the wiki pages. If you have suggestions for major changes or additional chapters, I suggest you post your ideas on the forum first for discussion.

    Frits

Viewing 3 posts - 1 through 3 (of 3 total)
  • You must be logged in to reply to this topic.
© 2021 Zynewave