Documentation review request

More
28 Mar 2013 22:38 - 30 Mar 2013 15:46 #8227 by PhracturedBlue
Documentation review request was created by PhracturedBlue
I'm just about ready to release Version 3.0 now.
I have updated the documentation for the Devo 6/8/12 and would like to have folks read it over and provide feedback before I make the relevant changes to the Devo10/7e docs.

Please look at the included PDF and provide feedback including anything I missed, typos, grammar, layout, etc.

Updated 2013-03-30
Attachments:
Last edit: 30 Mar 2013 15:46 by PhracturedBlue.

Please Log in or Create an account to join the conversation.

More
28 Mar 2013 22:47 - 28 Mar 2013 22:49 #8230 by DarkWolf
Replied by DarkWolf on topic Documentation review request
Well, so far I'm on page 24 and it looks great. Just skimming though and not looking for flaws. But from what I see, it's very easy to follow.
Last edit: 28 Mar 2013 22:49 by DarkWolf.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 00:12 - 29 Mar 2013 00:24 #8231 by sbstnp
Replied by sbstnp on topic Documentation review request
I'm not trying to send SPAM lol.


Page 27, 'A7104' hardware module.
Page 36, swash section, the'Helicopter'. A space is needed.

That's all I can find for now, but it's 2:18AM here I'll give it another read in the normal 'morning' :lol:

Devo 10 + 4in1
Spektrum Dx9
FrSky Taranis + TBS Crossfire
Last edit: 29 Mar 2013 00:24 by sbstnp.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 05:23 #8237 by vlad_vy
Replied by vlad_vy on topic Documentation review request
Page 11: General Settings - not needed 'Buzz volume: Set buzzer volume'

Page 23: Channel configuration - not reflected Scale+: and Scale-:, Min/Max instead Min Limit/Max Limit

Page 26: Protocol: DSM2 - While the DSM2 protocol can support up to 14 channels,
Deviation is currently limited to a maximum of 12.

Page 27: Protocol: DSMX - While the DSMX protocol can support up to 14 channels,
Deviation is currently limited to a maximum of 12.

Please Log in or Create an account to join the conversation.

  • rbe2012
  • rbe2012's Avatar
  • Offline
  • So much to do, so little time...
More
29 Mar 2013 08:56 #8240 by rbe2012
Replied by rbe2012 on topic Documentation review request
Page 5 1st paragraph "switcihg"
Page 6 1st longer par. "the transmitter calibration must be repeated" - better "stick calibration"?
Page 7 is empty?
Page 8 (screenshot): there have been some users asking about the data fields on the right - should be noticed that it's en emulator screenshot?
Also: The icon is labelled "Model Configuration Pages", the top left icon "TX Configuration Pages". All others are only descriptions while these two show what is behind. Should this be noticed? Or should their boxes colored different to make clear there will be a difference?
Also: The description list is not good structured due to identical line distance. It would be more clear if the space between the items would be a little bigger.
Also: Trims: No trims were also possible.
Page 9 Navigating: A problem which occurs from time to time is that users do not realize the difference between grey and white spin boxes and that they should try to press the grey ones. Would be a good place to notice here.
Page 9 Menu layout: I would prefer the second picture to show the same way like the first and third: on the left only the Main point, the submenu cycle on middle and right.
Page 10 emulator: The keys are mapped different on the different country layouts, but the key codes are scanned. So on a German keyboard the "\" is placed on the "ä" and "y" and "z" are swapped. So a recommendation to use an English keyboard layout or at least a notice that this description is valid only for those would be an help.
Also: you will not find Throttle, Aileron... in the data field on the right. So I would prefer something like "Left-Vertical Stick (Throttle in Mode 2)" for the sticks.
Page 11, Version Page: "and moving left two pages" - with mine it's only one page left.

So far for now.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 09:17 #8241 by upside_down
Replied by upside_down on topic Documentation review request
On top of page 25:
Text Mixer GUI and Model Name is interchanged.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 09:26 - 29 Mar 2013 10:13 #8242 by RandMental
Replied by RandMental on topic Documentation review request
Page 4:
"Deviation is a replacement firmware for the Walkera Devo© series transmitters.
The core of the Deviation firmware is the mixer system, which is modeled after the system used in the Er9X firmware for the Turnigy/Flysky9x© transmitters."


"Walkera Devo© series" I believe to be technical correct it should be "Walkera Devention(TM) series, also called Devo" The same would probably apply to Turnigy/Flysky9x©, the (C) should be a superscript TM.

I know spelling will be the last check, but here are a few in the mean time:

Page 5 - Typo switcihg - switching
Page 14 - Typo Preview: effect should be affect
Page 28 - Type second "flipping" is written with one p
Page 29 - Typo apropriately -> appropriately
Page 36 - Typo settigs -> settings; degress -> degrees

Lastly to improve comprehension and readability, as RBE2012 also mentioned above, I would suggest a 1.5 line spacing after a paragraph, and also before & after tables, Screen pictures, lists, etc.
Last edit: 29 Mar 2013 10:13 by RandMental.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 10:17 - 29 Mar 2013 10:22 #8243 by RandMental
Replied by RandMental on topic Documentation review request
For improved readability of the Emulator Key legend table on Page 10 - if the colums are narrower, it is much easier for the eyes to quickly find the info, e.g. this table I made to print for quick reference.
Attachments:
Last edit: 29 Mar 2013 10:22 by RandMental.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 15:46 #8249 by FDR
Replied by FDR on topic Documentation review request
Page 5:
Plug the transmitter into the PC via USB, and turn on the transmitter while holding 
‘EXT’ to enter programming mode.
AFAIK on the DEVO 12 they should hold the trainer switch to go into upgrade mode...

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 15:48 - 29 Mar 2013 15:49 #8250 by FDR
Replied by FDR on topic Documentation review request
Page 6: may be you could mention about the error.txt in the table...
Last edit: 29 Mar 2013 15:49 by FDR.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 19:49 #8252 by FDR
Replied by FDR on topic Documentation review request
Page 6:
I would exchange the first time install and the upgrade instructions, since the install guide more likely needed for those, who do it the first time.
I wouldn't call replacing the Walkera fw as upgrade either...

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 19:51 - 29 Mar 2013 20:01 #8253 by FDR
Replied by FDR on topic Documentation review request
Page 8:

Trims: The trim display can be configured to show either 4 or 6trims

...if they are shown at all.

EDIT: ...and Page 14 the "No Trims" option is missing from the Trim Positions section too.
Last edit: 29 Mar 2013 20:01 by FDR.

Please Log in or Create an account to join the conversation.

More
29 Mar 2013 21:19 #8254 by PhracturedBlue
Replied by PhracturedBlue on topic Documentation review request

FDR wrote: I wouldn't call replacing the Walkera fw as upgrade either...

Well, I think it is an upgrade at least :)

Point taken though. I've fixed this along with most of the other issues folks have reported. Thanks everyone for spending the time on this.

Please Log in or Create an account to join the conversation.

More
30 Mar 2013 15:48 #8298 by PhracturedBlue
Replied by PhracturedBlue on topic Documentation review request
I've uploaded updated copies of both 6/8/10/12 and 7e/10 manuals into the 1st post.

Feel free to look them over, but personally I think they are likely good-enough for the release.
I'll go through the bug list on Bitbucket again, but other than updating the site for the release, I think I'm just about ready for 3.0

Please Log in or Create an account to join the conversation.

More
01 Apr 2013 19:09 #8390 by sbstnp
Replied by sbstnp on topic Documentation review request
Page 27, 'A7104' hardware module.

Devo 10 + 4in1
Spektrum Dx9
FrSky Taranis + TBS Crossfire

Please Log in or Create an account to join the conversation.

More
01 Apr 2013 19:09 #8392 by vlad_vy
Replied by vlad_vy on topic Documentation review request
For Devo 7e will be nice to have description of protocol folder (install and description).

Please Log in or Create an account to join the conversation.

More
01 Apr 2013 19:36 - 01 Apr 2013 19:38 #8396 by RandMental
Replied by RandMental on topic Documentation review request
www.deviationtx.com/forum/7-development/...-work?start=100#6586

This post from FDR indicates that on the 7e one has to also copy the protocol directory.

Currently the Protocol directory is not part of the directories under Filesystem which should be copies and the Devo10/7e manual does not mention the specific requirement to also copy protocol directory.

Edit - Sorry Vlad_vy, just saw your post two message earlier
Last edit: 01 Apr 2013 19:38 by RandMental.

Please Log in or Create an account to join the conversation.

More
02 Apr 2013 15:32 - 02 Apr 2013 16:45 #8431 by vlad_vy
Replied by vlad_vy on topic Documentation review request
DeviationUserManual_2013-03-30

Page 27 - Protocol: PPM

The Flysky (PPM???) protocol also supports additional options. These are accessed by pressing the protocol spin-box when Flysky (PPM???) is shown:
• Center PW: defines the pulse-width when sticks are centered

Table of Contents - page numbering is incorrect. At contents - 43 pages, really - 40 pages.
Last edit: 02 Apr 2013 16:45 by vlad_vy.

Please Log in or Create an account to join the conversation.

Time to create page: 0.057 seconds
Powered by Kunena Forum