Manejo de documentación en papel [cerrado]

Question

Después de cada nuevo programa escrito queda una gran cantidad de documentación en papel.

Aparte de las habituales notas de garabatos de los programadores, generalmente hay una buena cantidad de documentos que contienen explicaciones de modelos físicos, cálculos, etc. (ecuaciones, tablas, gráficos, pequeñas imágenes que describen variables ...)

Por lo general, hacemos cálculos numéricamente intensivos en aplicaciones de consola, que no se publican al público (permanecen en la casa, solo salen los resultados). Antes de que finalice cada proyecto, todos esos documentos deben estar empaquetados de alguna manera con la aplicación, de modo que un día, cuando alguien reutilizará partes de ella, tenga una idea de qué es lo que hay allí. Hasta ahora, hemos estado utilizando la solución "sucia" de solo escanear todo y empaquetarlo en el disco con la aplicación.

Así que me preguntaba ... para todos los científicos aquí en una situación similar ... ¿cómo maneja la documentación del proyecto que se necesita, pero no se divulga al público? (el que lo hace, va a las ddp laddies, y lo hacen agradable y brillante, ya no es nuestro problema :)

Answer 1

Uso una de las tres opciones:

• Guardo todo en mis cuadernos de laboratorio, que yo mismo archivo, para cosas de bajo nivel
• Escanee el documento en papel y añádalo al control de código fuente en pdf. Es feo, pero si alguien lo necesita, está ahí
• Transcriba las ecuaciones, los resultados, etc. en un formato limpio (generalmente Latex) para futuras referencias, y nuevamente, agregue al control de código fuente. La copia oficial en papel se firma (trabajo en un dominio altamente regulado) y se archiva en una carpeta.

Answer 2

En los proyectos en los que he trabajado, hemos realizado muchos cálculos de física en nuestros programas y, por lo tanto, tenemos muchas sesiones de pizarra con ecuaciones en las que estamos trabajando.

Mantenemos una wiki para cada proyecto principal y, después de cada sesión de pizarra, fotografiamos físicamente la pizarra con una cámara digital y la cargamos / organizamos dentro de la wiki. También escaneamos documentos en papel de los cuadernos de desarrolladores, si es importante, e incluímos también en la wiki.

Luego, hacemos una copia de seguridad de la wiki en el disco para su almacenamiento. Por lo tanto, nuestra solución es bastante similar a la suya, aparte de que usamos el wiki del proyecto para la organización.

Answer 3

Si es importante, me parece que debe tratar la documentación interna con el mismo cuidado con el que trata a los documentos públicos.

Answer 4

Al crear la interfaz de usuario de una aplicación, creo prototipos de papel de interfaz de usuario, que producen muchos papeles de tamaño A3 (en un proyecto tuvimos muchos escritorios cubiertos con papeles). Cuando el diseño está listo o necesita ser enviado por correo a alguien, le tomo fotos con una cámara digital, para poder producir una serie de imágenes que muestren cómo realizar algunas tareas en la interfaz de usuario, que sirve como documentación de cómo La aplicación está destinada a trabajar. Esto también sirve como respaldo, en caso de que alguien robe / limpie los papeles originales.

Answer 5

Estos son algunos de los pensamientos ... aunque no tan prácticos :)

1. Podemos hacerlo parte de nuestras notas de registro. Esto puede ayudar a los desarrolladores a mantener la aplicación.
2. Actualice el documento de requisitos / documento de diseño de bajo nivel con estos elementos