Documentation Improvment Ideas
Posted: Fri Feb 18, 2011 9:47 pm
Hello All!
If you're reading through the english secu3 docs on http://secu-3.org/ and you notice anything that isn't quite right, place your suggestions in this thread and STC can consider them as improvements in his own time.
Mine for today:
schemas > schematics
I don't understand what this sentence is trying to tell me "You can use results represented on this site in all your needs, therefore it is necessary to refer to original author(s)."
"double coils" later you say 2,4,6,8 cylinders so I assume that you mean double post coils, if so, you need to add "post" in there otherwise it sounds like 2 coils, not each coil having two posts/HT connections.
Replace this screen shot with one of the English version (or people will assume it doesn't exist!) http://subversion.assembla.com/svn/secu ... am_mon.gif
what is a "commutator"?
It's more normal to say "timing" which is short for "ignition timing" than "advance angle" in the general sense. EG "The ignition timing was set to an advance angle of 25btdc" does that make sense?
"Starter blocking when engine speed reaches specified value " interesting feature! (nothing wrong with the language, sorry for OT...)
"RS-232 interface for reprogramming, control and tuning with galvanic isolation. " what the hell is "galvanic isolation" ?
For the table of features, instead of the + you could/should use unicode ticks : either ✓ or ✔
"Description of communication protocol (Application)" - This should say firmware, not application. You DO use the term firmware in places, but not all places, I also find your repository name "secu3app" confusing/misleading, but maybe its just me?
"Useful advices and FAQ." - advice (it's a continuous quantity)
"Some packets may only be transferred, while some only received." sent and received or transmitted and received, probably the former is best.
"Ventilator" what is that?
"An open source, free, engine control unit for carburetor engines" Although this is clear when you read it a few times, you should probably make it this instead:
"An open source, free, ignition control unit" or "An open source, free, ignition controller"
OK, I've got things to do, so that's all for today from me, but anyone else, feel free to dive in and help too, I know JHarvey likes docs! :-)
Fred.
If you're reading through the english secu3 docs on http://secu-3.org/ and you notice anything that isn't quite right, place your suggestions in this thread and STC can consider them as improvements in his own time.
Mine for today:
schemas > schematics
I don't understand what this sentence is trying to tell me "You can use results represented on this site in all your needs, therefore it is necessary to refer to original author(s)."
"double coils" later you say 2,4,6,8 cylinders so I assume that you mean double post coils, if so, you need to add "post" in there otherwise it sounds like 2 coils, not each coil having two posts/HT connections.
Replace this screen shot with one of the English version (or people will assume it doesn't exist!) http://subversion.assembla.com/svn/secu ... am_mon.gif
what is a "commutator"?
It's more normal to say "timing" which is short for "ignition timing" than "advance angle" in the general sense. EG "The ignition timing was set to an advance angle of 25btdc" does that make sense?
"Starter blocking when engine speed reaches specified value " interesting feature! (nothing wrong with the language, sorry for OT...)
"RS-232 interface for reprogramming, control and tuning with galvanic isolation. " what the hell is "galvanic isolation" ?
For the table of features, instead of the + you could/should use unicode ticks : either ✓ or ✔
"Description of communication protocol (Application)" - This should say firmware, not application. You DO use the term firmware in places, but not all places, I also find your repository name "secu3app" confusing/misleading, but maybe its just me?
"Useful advices and FAQ." - advice (it's a continuous quantity)
"Some packets may only be transferred, while some only received." sent and received or transmitted and received, probably the former is best.
"Ventilator" what is that?
"An open source, free, engine control unit for carburetor engines" Although this is clear when you read it a few times, you should probably make it this instead:
"An open source, free, ignition control unit" or "An open source, free, ignition controller"
OK, I've got things to do, so that's all for today from me, but anyone else, feel free to dive in and help too, I know JHarvey likes docs! :-)
Fred.
