Re: comprehensive documentation


From: Brian Capouch (brianc_at_palaver.net)
Date: 2002-08-28 20:25:12 UTC



Jason Boxman wrote:> On Wednesday 28 August 2002 06:18 am, ClimbnRok_at_aol.com wrote:
>

>>with the growing popularity and maturity of hostap, I think it's becoming
>>more and more important to have comprehensive documentation of features
>>avaliable.  It will not only make it easier to set up an access point
>>correctly and securly, but all the features and their functions would be in
>>one place so someone wanting to contribute could get the whole integrated
>>picture of the project and get up to speed quicker.

>
>
> Sounds good.
>
>
>>If this is too daunting a task, then there should at least be documentation
>>for configuring everythign basic up to enabling wep, mac filtering, and
>>association monitoring.  This would make it easier to set up an access
>>point with the same capabilities as comsumer aps.

>
>
> I'm sure it's managable. ;)
>
>
>>I may just be lame and can't find the documentation, but if it takes longer
>>to find the documentation than it would to put in the hours to figure
>>everythign out, then what's the point really :)

>
>
> Documentation? When do we start?
>
> I have something up at
>
> http://trekweb.com/~jasonb/articles/linux_wireless2.shtml
>
> That article dosen't cover things like WEP, WDS, or HostAP in Infrastructure
> and Ad-Hoc modes. I do mention basic configuration and iwconfig usage, and
> bridging care of Jouni's generous example in README.prism2.
>
> What additional information and in what format(s) did you have in mind? I
> stuffed all that into plain text HTML pages. For documentation, something
> like DocBook XML, which I've never used, seems more appropriate, right?
>

I can "semi-volunteer" some students enrolled in my software engineering class. Each must perform 5 hours of "community service" over the course of the semester, and such things as doing documentation of open source efforts counts and is encouraged.

They are not experts in the subject domain, though; I can get them started and give them pointers to existing documents. But there will of necessity need to be someone of some degree of authority who can work with them to verify that their work is correct and helpful.

If anyone is interested in such an approach, please let me know. DocBook is in fact a possibility for us; there is some knowledge and experience in its use floating around here.

Thanks.

B.



This archive was generated by hypermail 2.1.4.