Documentation Issues

[christopher at ctmiller.n]

About the documentation issue...

As a guy who has been programming for 10 years, I have to defend
these guys a little, because I know exactly how difficult it can be
to document your own work. Working from the inside, you never quite
get the feel of the program as someone coming at it new. You make
assumptions that people know things, usually not even conciously.
So...I have to say that for the most part the docs have worked for
me...but then, as I said, I'm a programmer. I can guess what might
have been left out.

I want to make a suggestion. If you get a chance, head over to
www.php.net and look at the PHP manual. At the bottom of all the
entries are forum posting by people who use the software and have
learned tricks, have tips, or explain things. This might be a good
way to get the documentation that people want without asking Rob and
Colen to head back and rewrite it all.

Does this make sense to anyone else? I have to admit that this forum
serves a similar purpose, but perhaps a section by section breakdown
with user comments underneath might be easier to digest.

Just my two cents...
Chris Miller



To unsubscribe from this group, email

armybuilder-unsubscribe@yahoogroups.com

Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/

 

[ace at madbomber.net]

I still like the idea of putting together an EXTENSIVE example scenario--and
am interested in doing it, but have not found tons of free time I'll
give it the ol' college try.

>-----Original Message-----
>From: Chris <christopher@ctmiller.net>
>[mailto:christopher@ctmiller.net]
>Sent: Thursday, February 27, 2003 8:31 PM
>To: armybuilder@yahoogroups.com
>Subject: [AB] Documentation Issues
>
>
>About the documentation issue...
>
>As a guy who has been programming for 10 years, I have to defend
>these guys a little, because I know exactly how difficult it can be
>to document your own work. Working from the inside, you never quite
>get the feel of the program as someone coming at it new. You make
>assumptions that people know things, usually not even conciously.
>So...I have to say that for the most part the docs have worked for
>me...but then, as I said, I'm a programmer. I can guess what might
>have been left out.
>
>I want to make a suggestion. If you get a chance, head over to
>www.php.net and look at the PHP manual. At the bottom of all the
>entries are forum posting by people who use the software and have
>learned tricks, have tips, or explain things. This might be a good
>way to get the documentation that people want without asking Rob and
>Colen to head back and rewrite it all.
>
>Does this make sense to anyone else? I have to admit that this forum
>serves a similar purpose, but perhaps a section by section breakdown
>with user comments underneath might be easier to digest.
>
>Just my two cents...
>Chris Miller
>
>
>
>To unsubscribe from this group, email
>
>armybuilder-unsubscribe@yahoogroups.com
>
>Your use of Yahoo! Groups is subject to
>http://docs.yahoo.com/info/terms/
>


------------------------ Yahoo! Groups Sponsor ---------------------~-->
New Yahoo! Mail Plus. More flexibility. More control. More power.
Get POP access, more storage, more filters, and more.
http://us.click.yahoo.com/Hcb0iA/P.iFAA/46VHAA/IMSolB/TM
---------------------------------------------------------------------~->

To unsubscribe from this group, email

armybuilder-unsubscribe@yahoogroups.com

Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/

 

[moser at unsw.edu.au]

"Chris <christopher@ctmiller.net>" <christopher@ctmiller.net> quoth:

> I want to make a suggestion. If you get a chance, head over to
> www.php.net and look at the PHP manual. At the bottom of all the
> entries are forum posting by people who use the software and have
> learned tricks, have tips, or explain things. This might be a good
> way to get the documentation that people want without asking Rob and
> Colen to head back and rewrite it all.

The PHP thing is a good manual, and I think the model would work well for
AB, but... somebody would have to web-ify the docs, moderate the comments,
host and maintain the site. Once you had it going it probably wouldn't be
too bad, but the initial setup will take a fair bit of time, and last I
heard Rob wasn't exactly rolling in profit margin...

- rob.
(no, not that rob; another rob.)


To unsubscribe from this group, email

armybuilder-unsubscribe@yahoogroups.com

Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/