[asterisk-doc] Proposal - documentation subject matter experts

Henk henk at osocoms.com
Mon May 1 12:13:09 MST 2006


Asterisk Friends,

It was good to see some activity at the doc list.  I agree that something
needs to be done with the documentation.    

I would like to have some feedback about the following idea:

	Identify people that would like to become a documentation subject
matter expert.  Some potential projects are:  ZAP, SIP, H323, Dialplan, Fax,
IAX, etc.  They do not need to have the ability to code. Reading code to
some extend would be great.

	Create a modular manual that provides all the information that
people need to know to get asterisk (based at subject) up and running.
Take SIP as an example.  I think that a good description of NATs and
Firewalls could avoid a lot of questions and would give a better
understanding about how the channel needs to be configured.  To be able to
keep up with development is it required that 'writers' and developers 'talk'
so that the new development can be put in the right documentation
perspective.   It would be great if the developer would be willing to review
the modifications that have been made to the documentation.  This would
improve the quality of the documentation.

	Another advantage could be that the documentation could be 'tested'
together with the software.  This would again improve the quality of the
documentation and could also encourage people to become an active tester of
the software.  This means that the whole project would benefit.  

	I think that at a later stage needs to be discussed about the
infrastructure that should be used.  Let's start to create content.

I don't mind to step up for the SIP subject. 

Looking forward to your comments,

Henk

  


-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.digium.com/pipermail/asterisk-doc/attachments/20060501/1089ac71/attachment.htm


More information about the asterisk-doc mailing list