Que te parece la actual documentación

edited mayo 2008 in Documentación
En este post quiero iniciar un debate sobre la documentación actual y más concretamente sobre el manual de kumbia.

Que ampliar, que quitar, que mejorar...a partir de todo ello, iniciaremos la nueva documentación para la version 0.5.

También quisiera debatir sobre el nuevo esquema para el manual, como enfocarlo, etc...vamos!! a ponernos las pilas!!!

También trasladaré todos los topics de documentacion de otros partes del foro aqui.

Comentarios

  • edited 11:10
    Para lo que ya tenemos en la version 0.5 realmente el manual no es muy bueno sin embargo la critica es para ponernos en la nueva Docs tal y como comenta Phillipo particularmente estoy trabajando en un desarrollo donde he aplicado muchos de los nuevos conceptos que integramos en la version 0.5, de ahi puede salir mucha Docs sin embargo falta mucho trabajo.

    En primer lugar propongo que se haga el esquema de la Docs nos podemos apoyar con otros framework en cuanto a la forma que enfocaron su Docs y nosotros tener una idea.

    En segundo lugar nuestro Weblog ya esto se tiene un esqueleto falta el desarrollo del mismo pero ya existe una base sobre todo el Modelo de Datos que este Weblog manejara.

    Como siempre comento hay muchas cosas por hacer y somos pocos debemos hacer un buen plan de trabajo y comenzar atacarlo en las medidas de las posibilidades, como bien es sabido Kumbia es parte de nuestro tiempo libre aunq esto sea algo falso porq en realidad le dedicamos muchos mas de nuestro tiempo libre, basicamente porq nos sentimos identificados con este proyecto...

    Exitos....
  • edited 11:10
    Me parece muy buena idea lo que comenta deivinson, asimismo debe de generarse el indice de contenido, con enlaces para acceder a esas secciones (asi como aparecen en un panel a la izquierda del visor de pdf en los manuales de otros frameworks), creo que oowriter lo realiza de manera automatica.

    Me parece que la doc, en la edicion debe manejarse igual que como se maneja el codigo del framework, debe subirse al servidor svn, para que todos podamos ir trabajando en ella y asimismo cada mejora que se agregue se vaya integrando en la doc a la par.

    Eso si alguien debe encargarse de configurar el fichero fuente para el pdf (preferiblemente un .dot) con los correspondientes estilos, bueno supongo que a estas alturas eso ya debe estar listo. <!-- s:D --><img src="{SMILIES_PATH}/icon_biggrin.gif" alt=":D" title="Very Happy" /><!-- s:D -->

    Espero sus comentarios acerca de lo de controlar la edicion de la doc en el svn.

    Saludos
  • edited 11:10
    Bueno, yo creo que la documentación que bajé, a pesar de ayudarme en el empujón inicial, es pobre a la hora de emprender un proyecto de mayor complejidad. La guía de referencia de funciones es útil, y de ahí puede aprovecharse al máximo el funcionamiento del framework, pero los usuarios principiantes necesitamos ejemplos concretos. Esto parece trivial, pero puede darle mucho empuje a Kumbia.

    Por ejemplo: en un momentó encontré una dificultad con Kumbia (no me reflejaban los cambios en los formularios), y como era tarde y necesitaba probar otros frameworks, bajé Akelos, CodeIgniter y CakePHP. ¿Por qué volví a Kumbia? Por dos cosas, primero: porque me di cuenta que es mejor (no tomemos en cuenta este punto porque a lo que quiero llegar es a otra cosa) y segundo: porque algunos de los otros frameworks estaban MUY poco documentados. Ejemplo? Akelos. Sólo encontré algún videito, alguna referencia y nada más.
    Los demás tampoco están documentados de maravilla. Kumbia ya tiene algunas ventajas técnicas con respecto a sus competidores, si tuviera también una documentación sólida, creo que se posicionaría MUY bien por encima de sus competidores.

    Es sólo mi opinión, espero que algo de todo eso sirva <!-- s:) --><img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile" /><!-- s:) -->
  • concuerdo con que la documentación es bastante pobre, por ejemplo, estoy atorado con hacer un formulario estilo maestro-detalle. ademas, por lo que estuve mirando, creo que la libreria jquery que tiene kumbia, te permite hacer una especie de update o reload de algun objeto html del tipo select, pero no estoy seguro. documentación de las librerias y ejemplos concretos.

    Saludos.
  • Estamos trabajando en mejorar la documentación. Otro punto importante es saber sobre que versión de Kumbiaphp estás trabajando. Hay funcionalidades que en la versión 0.5 ya no existen en la versión 1.0.
  • Se deberían documentar ambos, pero en el caso de que no haya personas, sería mejor trabajar con la documentación de la ultima versión disponible...
Sign In or Register to comment.