[asterisk-doc] Web-based Documentation -- Need Help

[Jim Van Meggelen]

The thing to avoid is to write what has already been covered elsewhere. What
goes in asteriskdocs should be what is missing from A:TFoT.

We are working on a cookbook for O'Reilly, which will not hit the shelves
for a while; so rest assured there is writing going on, just not here. I do
not have enough bandwidth to write more than I already am, but I would be
delighted to provide some editorial assistance. People probably don't
realize how an editor can fix up a lot of the stuff that makes people think
they can't write. If someone takes the time to write something, even if it
has poor grammar and spelling mistakes and would upset your English teacher,
it is no big deal. That can easily be fixed during the editing process.

One person I think we should try to rope in is Ira. He say he can't write
but from what I have seen I beg to differ ;-). Also, he has some good ideas
about what was missing from A:TFoT, which is exactly what we want to move
towards.

A section of all the asterisk functions, and neat stuff that can be done
with variables would be useful.

Jim

--
Jim Van Meggelen
jim at vanmeggelen.ca
http://www.oreillynet.com/pub/au/2177

"A child is the ultimate startup, and I have three. 
This makes me rich."
                    Guy Kawasaki
--

 

> -----Original Message-----
> From: Peter Beckman [mailto:beckman at purplecow.com] 
> Sent: July 12, 2006 12:46 PM
> To: Asterisk Documentation Project List
> Subject: [asterisk-doc] Web-based Documentation -- Need Help
> 
> Guys --
> 
> I've put a lot of work and effort into the web-based 
> documentation, but as of late nobody has offered to help 
> (other than a translation or two).
> 
> Is asterisk-docs dead?
> 
> I know we all have our own stuff to do, as do I, but if 
> you're on this list, there's a reason.
> 
> Can I get some help?  I'll get SVN access for whomever will 
> help, but I need some backup here.
> 
> The current code:
> 
>      http://mph.gotdns.com:82/manual/en/
> 
> Items needing expansion:
> 
>      * Getting Started -- make a better tutorial
>      * Installation -- Make sure it is accurate
>      * Language Reference -- Could be expanded a bit, add AEL in
>      * Config File Ref -- Needs to include all possible config files
>      * Features
>      * Application Reference -- Not 100% done, but getting there.
>      * Asterisk Internals -- how does Asterisk work?  Maybe 
> get a guest
>        developer to write and we'll edit?
>      * FAQ -- pretty weak right now.
> 
> Like Ian or Ira said earlier, the Book is great, but we need 
> to build a reference manual.
> 
> The system is DocBook-based, and most of the code is stolen 
> from php.net (see http://php.net/manual/en/).
> 
> I don't know how it all works, and the search stuff doesn't 
> work yet.  I'm confident we can get it there, but I need help.
> 
> Beckman
> --------------------------------------------------------------
> -------------
> Peter Beckman                                                 
>  Internet Guy
> beckman at purplecow.com                             
> http://www.purplecow.com/
> --------------------------------------------------------------
> -------------
> _______________________________________________
> --Bandwidth and Colocation provided by Easynews.com --
> 
> asterisk-doc mailing list
> To UNSUBSCRIBE or update options visit:
>    http://lists.digium.com/mailman/listinfo/asterisk-doc
> 
> 
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.394 / Virus Database: 268.9.10/386 - Release 
> Date: 12/07/2006
>  
> 

-- 
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.1.394 / Virus Database: 268.9.10/386 - Release Date: 12/07/2006