Saltar al contenido
Portada » Cómo documentar correctamente un proyecto de software (y de paso, aprender un nuevo lenguaje)

Cómo documentar correctamente un proyecto de software (y de paso, aprender un nuevo lenguaje)

  • bocabit 
  • dev

Documentación vintageDespués de mucho sufrimiento puedo decir que por fin he terminado la carrera y ya soy oficialmente un “proyectante”, o en otras palabras, solo me queda el proyecto fin de carrera para convertirme por arte de magia en un Ingeniero.

Tras muchas cábalas, me decidí a desarrollar una aplicación para Mac (OS X) porque creo que es un sistema operativo cada vez más en auge, tanto en ordenadores como en dispositivos móviles y lo que aprenda puede servir para adquirir conocimientos que profesionalmente pueden llegar a resultar útiles.

Sin embargo, se me presenta un reto bastante considerable, que es convertirme en autodidacta y aprender un nuevo lenguaje de programación como es Objective-C/Cocoa y utilizar herramientas como Xcode, con las que mi experiencia es casi nula.

Por tanto, la dificultad es bastante considerable: lenguaje que no se enseña en la carrera + sistema operativo que no se utiliza en la carrera + IDE que no se utiliza en la carrera + ser autodidacta. Ya tengo unos cuantos libros para empezar a aprender, pero me sorprende que no haya por Internet ninguna herramienta para llevar a cabo este aprendizaje de manera más o menos óptima.

Lo que busco es una manera de tomar anotaciones, de acumular código que me pueda resultar útil en un futuro y también referencias de consulta y mantenerlo todo ordenador. Se me ha pasado por la cabeza utilizar Evernote, pero me tiró para atrás que no se pueda almacenar código fuente de una manera cómoda. Montar un blog privado resulta demasiado pesado y poco práctico a la hora de tomar anotaciones rápidas. La última alternativa (que en realidad fue la primera) es utilizar un wiki y he optado Dokuwiki porque me parece una alternativa sencilla con soporte para código fuente.

No sé si será la mejor opción, pero la principal dificultad va a ser tenerlo todo organizado desde un punto de vista práctico, tanto de cara a consultar información como a documentar las diversas partes del proyecto. A los que tenéis práctica con estas cosas, ¿Qué haríais en esta situación?.

Etiquetas: