Thread: The New Docs
View Single Post
Re: The New Docs
Old
  (#6)
>BKA< T Wrecks
Moderator [PBmm/Waypointing]& PODBot mm waypointer
 
>BKA< T Wrecks's Avatar
 
Status: Offline
Posts: 1,492
Join Date: Feb 2004
Location: C.C.A.A., Germania
Default Re: The New Docs - 19-05-2004

Hey Huntkillaz, excuse me for needlessly bothering you with that stupid PM I sent you! I just saw that 4 ppl had viewed my doc, but got no reaction whatsoever, so I got a little bit nervous.
It's a good idea that you opened a new thread for the docs - this will make it easier both for us and for other ppl to see what's going on.

Ok, I've had a look at bots2.6.htm, and now [nagging mode on] I'm gonna post some thoughts on it... (btw, I need someone to do the same with my docs; I don't see my own errors!)

bot2.6.htm

Quote:
Originally Posted by Huntkillaz
Counter might go for hostages, Terrorists may want to plant the bomb.
Well, in fact they WILL. "Might" and "may" sound too vague and optional, IMHO.

Quote:
Originally Posted by Huntkillaz
If a map has loaded, press the key (...)
That sounds as if it weren't too certain to happen that a map actually loads. Wouldn't it be better to say "As soon as the map has loaded, you can press..." ?

Concerning the "wptfolder" command:
1. Wasn't there something in the old doc that said changing the folder wouldn't take effect until the next mapchange / game start? If this is still valid, it ought to go into the documentation as well.
2. In order to make things clearer, I think it would be best to add an example that shows how to do it (like "wptfolder mywpts") and, maybe more important, one that shows how NOT to do it (like "wptfolder my wpts_2" or "wptfolder test\customwps", each of these examples in the appropriate place?

In the "Radio commands" section:

Quote:
Originally Posted by Huntkillaz
A Terrorist Bot carrying the C4 or picking it up, will also issue a "Follow Me"...
I think the comma is wrong / superfluous, but I'm not a native speaker, so...
Quote:
Originally Posted by Huntkillaz
Makes a Bot who's following you, stay a while...
see above.

Under "Bot Personality"
Quote:
Originally Posted by Huntkillaz
if you have 'detailnames' turned on they can are shown through the Prefixes
little mistake (the "can are"), we will find lots of these in all our stuff, I expect...

BotChat:
Maybe it would be ideal to add the info that each BotChat contains a section where the chat system is explained, just to let ppl know they can edit all this to their respective likings and don't depend on the ones that came with the bot.
[nagging mode off]

Well, I think for a first version, this was more than ok! Finally some general thoughts:
- I think a combination of white BG / black text would be more comfortable to read on screen. If ppl want to dig into the more detailed stuff, they will of course print the whole stuff. But whenever someone just wants to look up a certain point, he'll have an easier read if it's good old black on white.
- sPlOrYgOn is right: Make it according to w3c standards. The docs must be readable on Linux and Win32, with IE, FireFox, Mozilla, Netscape, Opera and... well, even with that shitty AOL browser, I guess! Compatibility is god in the case of reference documentation; on the other hand, flash and all other eye candy is not really needed. If this were a page to show off on the www, ok. But documentation should be clean & free of unnecessary bulk.
- Why do we include the original docs? Was it to make sure that we don't violate CF's copyrights or something? Because really, when I have PODBot 2.6 and use it, I don't care about reading obsolete stuff about older versions in the documentation.
- I had actually planned the "common errors" doc as the last section of the "basic waypointing" part. The "advanced waypointing part was to contain the really 1337 stuff and all those fine tweaks that separate a truly good WP file from the merely working ones.



Roses are #FF0000, violets are #0000FF // all my base, are belong to you.


Last edited by >BKA< T Wrecks; 19-05-2004 at 20:08..
  
Reply With Quote