Menu

#7 Manual needed

open-accepted
Manual (1)
5
2010-10-03
2010-09-28
No

Manual is needed, which describe all function of software with example solutions.

Bugs like inaccurate timer v34 occur because lack of documentation...

Any help welcomed

Discussion

  • hwhacker

    hwhacker - 2010-09-28

    I can browse whole interface and write shortly about each feature. You'll then correct it and add what I don't know / leave out. I can make drawing of radio face which can serve to show which button does what in various screens. What document format would You prefer, doc, odt, pdf, txt, rtf? I guess sharing via SVN here, right?

    Ideas for helpfile:
    - Tree structure of menus
    - "screenshots" of settings - examples
    - online version of help (html, no need to download files)
    - guide for setting most common mixers (V tail, elevons, etc)

    structure of document:

    1. tree structure with links to pages
    2. general description of every feature (to get picture of what I probably need to set up if I want to do XYZ thing)
    3. complete description of every feature with example
    4. most common mixes

     
  • Rafal Tomczak

    Rafal Tomczak - 2010-09-28

    ODT is ok.I use Open Office. I planed sharing it on SVN. Other possibility it to make it on WiKi. But that cause more problem at start. More competed version can be pdf files in download section.

    I have read Erazz version of manual: http://er9x.googlecode.com/svn/trunk/doc/ER9x%20Users%20Guide.pdf It's easy to read, almost like normal book, but has everything inside.

     
  • hwhacker

    hwhacker - 2010-09-28

    It's not bad, just I'd use numbered lists for all setup procedures. Especially if it takes +10 steps to make delta mixing with curved dual rates assigned to separate switches :D. You're squeezing maximum out of that radio, and that requires one heck of a manual :)

     
  • Rafal Tomczak

    Rafal Tomczak - 2010-10-03

    Check this one: http://radioclone.svn.sourceforge.net/viewvc/radioclone/Manual/
    I know it's buggy, and it only a small part, but You can check if I go into right direction.

     
  • Rafal Tomczak

    Rafal Tomczak - 2010-10-03
    • status: open --> open-accepted