Documentation suggestion

thread: 5 messages  |  last: about 11 years ago  |  started: sunday, june 3, 2007, 1:22 pm pdt


#1  |  Guizmo (Paris) France
Sunday, June 3, 2007, 1:22 PM PDT

In order to have up to date documentation, why not trying these steps :

1. You finalize a QCodo release on development and focus on making the documentation for it.
2. You collect profiles from the community who are ok to participate in documentation update for the releases following the one you have just finished
3. Once you have made the last documentation and found the volonteer profiles, you can continue improving and they can have a good learning of QCodo which will allow them to update the documentation based on your work..

#2  |  Mike Ho (San Diego, CA) United States of America Qcodo Administrator
Monday, June 4, 2007, 11:46 PM PDT

Thanks for the suggestion!  Actually, a process like this is more or less already in place.  There are a few members of the core community group (namely Yong who is leading the efforts) who are generously contributing their volunteer and free time to help with the documentation effort.  But because it's a purely volunteer effort, the task for this will understandably not always be a top priority as other things may take precedence.

But with the infrastructure in place for the members to be able to work on documentation, things are moving forward with that aspect.

The third suggestion of having the development team “wait” until the documentation is complete is unfortunately unrealistic.  As technology in the landscape continues to evolve and grow, qcodo (both the community and the framework) will continue to change and grow as well.  To simply wait until one thing is done until we can do the other is simply unrealistic given this climate.

The good news is that because it is open source, and because there (hopefully) is a great deal of consistency with the way qcodo is architected, as you learn and master one part of qcodo, understanding other, newer parts shouldn't be nearly as difficult or complex.  And furthermore, things like the examples site and the forums serve to help users where the current documentation may not be able to yet.

Hope that helps!

#3  |  Guizmo (Paris) France
Thursday, June 7, 2007, 1:21 PM PDT

Ok i understand so maybe a little more examples and up to date examples regarding QCodo evolution, just an idea

#4  |  saganxis Argentina
Wednesday, November 14, 2007, 5:39 PM PST

I want to help with the spanish translation of the Qcodo Manual or other documents. Is there any way to do this???

#5  |  Mike Ho (San Diego, CA) United States of America Qcodo Administrator
Thursday, November 15, 2007, 11:32 AM PST

Yes!  You should speak with kristof, who manages the Qcodo Manual project.



Copyright © 2005 - 2018, Quasidea Development, LLC
This open-source framework for PHP is released under the terms of The MIT License.