Documentación de soluciones implementadas en un proyecto de software.

Como desarrollador de software, me quedo atascado al implementar una función y luego la resuelvo de alguna manera a través de muchas búsquedas, lectura de artículos, tutoriales, etc.

Pero preferiría una aplicación web (por ejemplo, un repositorio central) que tenga un flujo de trabajo definido que me permita almacenar/documentar este tipo de soluciones a ciertos problemas en un proyecto de software. Para que pueda buscar y consultar el repositorio nuevamente en el futuro para recordar cómo resolví un problema si lo encuentro nuevamente.

Los blogs ayudan, pero algunos problemas de programación son muy pequeños y se vuelven muy triviales para una publicación de blog. Por otro lado, no puedo describir una solución técnica completa en los rastreadores de problemas.

Sugiera si hay alguna aplicación web como esa por ahí.

Respuestas (2)

Estoy usando un wiki para un caso de uso similar.

Lo bueno: puede construir la arquitectura/organización/navegación del sitio usted mismo.
Lo malo: tienes que construir la arquitectura/organización/navegación del sitio tú mismo.

Casi cualquier wiki debería ser adecuado para su caso, pero vale la pena investigar los detalles que le interesan.

Wikipedia tiene una lista y comparación de software wiki. El sitio wikimatrix.org permite comparar wikis según las características/requisitos seleccionados.

No subestimes la apariencia. Para que una wiki de este tipo realmente tenga sentido, debe visitarla y editarla con frecuencia. Pero si la edición no es divertida (es decir, no es fácil/rápida, fea, mala facilidad de uso) para usted, puede posponerla o detenerse después de los primeros días de entusiasmo.

Personalmente, estoy usando WikkaWiki ( diariamente cada hora durante varios años, he creado alrededor de 2000 páginas con más de 35000 ediciones):

  • SEDA FLOJA.
  • PHP, MySQL.
  • Rápido, pequeño cruft.
  • Viene con sintaxis para bloques de código ( %% your code here %%) y admite resaltado de sintaxis ( %%(php) your PHP code here %%). Incluso puede especificar un nombre de archivo (que también permite descargar el archivo de código) y números de línea de inicio ( %%(php;15;test.php) your "test.php" here, starting from line 15 %%).
  • Su editor predeterminado admite Tab(si desea sangrar el código de esa manera).
  • Debido a que las URL son "hermosas", podrá ingresar directamente las URL de las páginas que desea visitar/editar (lo que ahorra mucho tiempo, gracias al autocompletado del navegador):
    http://example.com/PHP
    http://example.com/PHP/edit

Posibles inconvenientes: proceso de desarrollo bastante lento (lo cual es bueno para mí, siempre que el proyecto no esté muerto); no hay soporte completo para Unicode (la próxima versión, 1.4, cambiará a UTF-8 completo; pero casi todo debería funcionar bien incluso ahora).

DokuWiki es otra buena wiki. También es FLOSS, usa PHP, pero no requiere una base de datos (guarda todas las páginas wiki en archivos de texto).

Finalmente he decidido conformarme con Git y Markdown . Para el alojamiento de Git, elegí GitLab porque es básicamente GitHub con la adición de repositorios privados gratuitos . La idea es tener un solo repositorio para todos los registros y luego tener un solo directorio para cada registro o entrada:

-root
  -Entry1
     Entry1.md
     file1.js
  -Entry2
     Entry2.md
     Entry2.html

También planeo aprovechar la vinculación relativa y el resaltado de rango de línea para hacer referencia a archivos de código dentro de un directorio de entrada o en todo el repositorio.

Tal vez incluso pueda hacer un repositorio para mi blog algún día.