Documentation Discussion

I have started working on sections of the documentation. My method includes only working on small sections at a time to facilitate discussion, editing and acceptance. The first sections I have to show you are the top level discussion of the Main menu and the top level discussion of the Transmitter config menu.

I have added a .pdf extracts to the downlaods of my cloned repository of the manual and will post links to the extracts here.

The first is pages 10-13 of the English only deviationTX manual for the devo10/devo7e.
Deviation10UserManual_p10-13.pdf

Great job. I assume chapter numbers to be placed later on.

Just two small things:
Please put the note from page 11 to the lines with 'Model menu' above.
Please add a note for Batt alarm on Devo7e: Min is 3.3V Standard alarm 4.1V (4 cells only ).

Are you planning to add some additional info for sticks calibration in this chapter? Like press ENT and follow the instruction....

I think LibreOffice does the same thing that Word does, I can auto-generate a TOC from the headings.

Thanks for the 7e stuff, I am not up on the 7e since I don't have one.

I have forked PB's documentation, if you clone mine you can make the appropriate Devo7e changes and add make a pull request that I can aggregate and then send to PB.

Made corrections and posted on the document repo.

I know that the Scale option will modify the display of the Channel output screen, are there any other options that effect the channel output and are visible on the output screen?

It appears the Stick input screen is always based on a -100 to +100 scale, is this correct?

For the input: with calibrating you make sure that the values are in the +/100%-range. So: yes, correct.

I just reworked pages 4 to 8 but when I try to pull I get:
WheresWaldo could you please check and add the attached file to your repo.

May be someone can help me with the settings for TortoiseHg. I do have an account on bitbucket and cloned his repo. Is there anywhere an Howto or Tutorial?

You can't send directly to my repo. You send to yours and then ask for a pull request.

WheresWaldo wrote: You can't send directly to my repo. You send to yours and then ask for a pull request.

.... send to my fork of your repo.... done

Please check the changed pages regarding spelling.
I would like to continue on page 9 to 11 with removing the emu to the end of the manual with some reordering of the 'main menu' and 'navigating' chapter.

Merged your pull request and made a few changes to grammar to clarify and make reading easier. Changed the margin spacing and adjusted images to fit better. Also forced keeping aspect ratio on all images up through page 12 so the images do not appear distorted.

Note that I changed every reference of Deviation to deviationTX as that is the proper name. Also any abbreviations were lengthened to the complete word. Abbreviations are great for online discussions and text messaging but wholly unnecessary in written documentation.

kreidler, I added the telemetry paragraphs and image this morning, resync your repo with mine so you have the latest file.

I am going to export a .pdf excerpt of the latest changed pages and link to it here so others can see how it is shaping up.

Deviation10UserManual-p13-16.pdf

I have most of the screens already but have found some errors in capturing them, so a few I have to go back and redo when I spot the error. It was easier to just sit in the emulator and take screenshot after screenshot then combine whichever ones needed it as I went along. I will try to keep up with the latest development builds so I make sure that the documentation is current.

Am scratching my head on how to combine Devo7/10 + Devo8/12. They are so different in how you access items that it would require a lot of explanatory notes and comments about this or that feature's availability in certain Devo versions. Probably easier to still keep them separate.

WheresWaldo wrote: Am scratching my head on how to combine Devo7/10 + Devo8/12. They are so different in how you access items that it would require a lot of explanatory notes and comments about this or that feature's availability in certain Devo versions. Probably easier to still keep them separate.

I proposed some time ago just to add the corresponding screen to one manual. In PB's opinion this would not be so easy. Meanwhile I fully agree. If you count the notes for the 7e in the manual we are working on and then thinking about even more notes I would prefer to continue with two issues.

@kreidler

I am thinking about moving the 'Model setup' up before the 'Mixer' as most people would logically start there. What do you think about breaking out the protocol explanations to later in the documents as I believe most people buying a Devo will do so with a Walkera RC. If they change protocols they likely know what they are and it would streamline the setup process for them.

So I propose just mentioning the available protocols in this section then going into the lengthier descriptions in another section or appendix.

I also think that once the Devo7/10 Doc is done, it would be easy to reformat the 8/12 manual since most of the explanatory text would be just a cut and paste with mainly changes in navigation.

I opened some time ago a ticket on rbe's repo requesting model setup to be the first entry in advanced GUI. He replied that in Standard GUI the Mixer is not existing (I was not aware of this) and so the Standard GUI will start with the 'Model Setup'. Nevertheless I do not understand why the Advanced GUI has to start with Mixer. All functions you set up with Mixer are the ones coming behind 'Model Setup' in Standard GUI. Main reason might be backwards compatibility / feeling to Origin Devo. May be PB can give some additional clarification.

WheresWaldo wrote: So I propose just mentioning the available protocols in this section then going into the lengthier descriptions in another section or appendix.

Some of the information is really useful for setting up / successful binding already. I would remove the optional protocols which needs an extra module installed to the appendix. Just like on the homepage of deviationtx.com. And in the appendix could be a link to the moduleinstallation file or even the complete file included.

Should we add photos of the Txs with explanation of the controls or can we presume that the user knows 'What is What'? Image available in better quality .

Thanks FDR

I use the mixer only if I have a new model until it flies like hell ....... Sooorry
If I am going once in the Mixer, this tab will be active in 'Model Menu' until I choose a different item from the 'Model Menu'. So, once selected you only need ENT until power down.

BTW: 'Mixer' is one of my defaults on 'Main screen config' for the the menus.

EDIT: Saw your edit: Yepp, Devo 10 change?