Proof Reading a Tutorial

[Ice_Rhino 3]

Hi All,

With all the fun and mistakes I made trying to get an insertion and extraction of AI squad via helo I thought I would write up what I did/learned and post it. Even perhaps considering doing my first YouTube video for it. I intend to make the mission available (sqm) as part of the tutorial so people can see for themselves.

I just wondered whether anyone in the know would be willing to read (just over one page of A4) what I have typed up. I intend to go through it step by step myself first but subject to any changes I make I would like someone to cast a knowing eye over it.

Kindest Regards

Edited August 8, 2013 by Ice_Rhino
Bad Grammer on Right instead of write

[cuel 25]

Sure.

[kylania 568]

Of course, post it or send it or read it out loud. :)

[Ice_Rhino 3]

Are we sitting comfortably, then we shall begin..............

Oh actually just read it here SkyDrive Link

Be gentle, just learning and trying to help others

[kylania 568]

First second thoughts...

Separate all code samples into code display blocks.

Bold or otherwise highlight all controls.

Italize or otherwise highlight all variable/object names.

No one uses the word "bespoke" :) "Where I have listed names to use for units I have marked them in red." might be better?

You're using the funky ' (single quote). People are going to copy/paste that and it's going to cause issues. Stick with just a color highlight or italics. You also don't use that uniformly. Definitely remove all single quotes and replace with highlight boxes.

Maybe include pictures from the editor, especially for things like init fields and the like.

( ) are used to control the order of evaluation. Just like in math:

 2 + 2 * 2 = 6 vs (2 + 2) * 2 = 8

[ ] is an array, a data type which is a list of things. _units = [unit1, unit2, unit3];

{ } is a code block. As in the code executed for each passthrough of a forEach.

You can get around the whole lone alive OR in u1-8 stuff by naming your group in step 3 (groupName = group this; in the leader's init) instead of naming each unit. Then replacing the condition with:

{alive _x and _x in blu_exthelo_1} count units groupName == {alive _x} count units groupName

You name the player, player_1 but never use that variable. You also don't need to name the player since you can use player to refer to him later. Sometimes you need the unit name though, but it shouldn't be "player" but instead something more specific like unit1 or p1 or whatever.

Edited August 8, 2013 by kylania

[Ice_Rhino 3]

I get the idea of what you are saying. I will rewrite it accordingly.

Thanks

[cuel 25]

Converted it to .doc and left comments

download

[kylania 568]

Here's a quick example of what I was thinking with some of my suggestions.

[Ice_Rhino 3]

Posted a reply and it hasn't appeared, weird. Anyway,

My sincere thanks to you both. I shall try to incorporate both your sets of suggestions and repost here accordingly.

Again, my thanks

[Valixx 11]

I would be interested too. I'm writing some guides at my forum and i'll publish some scripts from my mission later on :)

The community here helped me alot, especially kylania so i'm giving something back to them.

[Ice_Rhino 3]

The revised version is complete. It is available here on my SkyDrive Link

It should be a hybrid of KYL and CUEL suggestions

I await your opinion(s)

Thanks again

[cuel 25]

Looks much better :)