Preguntas etiquetadas con documentation

18
¿Código autodocumentado vs Javadocs?

Recientemente he estado trabajando en la refactorización de partes de la base de código con la que estoy trabajando actualmente, no solo para comprenderlo mejor, sino también para que sea más fácil para otros que están trabajando en el código. Tiendo a inclinarme al lado de pensar que el código...

18
¿Qué deberías dejar para tus sucesores?

Suponga que es un desarrollador exclusivo que deja un trabajo. ¿Qué tipo de información / material, fuera del código mismo, debe crear y dejar para su reemplazo? Una respuesta obvia es "lo que quieras en un nuevo trabajo" con seguridad, pero ha pasado un tiempo desde que comencé un nuevo trabajo,...

17
¿Qué estándar reemplazó a 830-1998?

He estado investigando cómo documentar proyectos de software de manera más formal, y he aprendido sobre IEEE 830-1998: Práctica recomendada para especificaciones de requisitos de software . Sin embargo, como puede ver en ese enlace, se ha reemplazado. Sé que 830-1998, y probablemente incluso...

15
¿Es redundante decir "Objeto JSON"?

Si JSON significa JavaScript Object Notation, entonces cuando dices JSON object, ¿no estás diciendo realmente "JavaScript Object Notation Object"? ¿Sería más correcto decir "cadena JSON"? ¿O sería más correcto simplemente decir JSON? (como en "Estos dos servicios pasan JSON entre...

15
¿Cuánta documentación es suficiente?

¿Cuánta documentación técnica (para futuros desarrolladores) es suficiente ? ¿Existe una relación entre las horas de codificación y las horas de documentación que sea apropiada? Papadimoulis argumenta que deberías producir la menor cantidad de documentación necesaria para facilitar la mayor...

14
¿Cómo documentar un idioma ubicuo?

Nuestra compañía está en proceso de convertir muchos procesos comerciales manuales (y el conocimiento institucional asociado) en un nuevo software empresarial. El proyecto está yendo realmente bien, pero a medida que avanzamos, está claro que existe mucha confusión con respecto a los términos y...

13
Pasar de un proyecto de un hombre a un proyecto de equipo en el futuro. ¿Qué debo hacer ahora en preparación y qué puedo esperar?

Para dar más detalles, estoy interesado en saber qué piensa la gente que necesita implementar mientras aún es un proyecto de un solo hombre (control de la fuente del equipo, documentación, compilaciones, etc.) y qué cosas no es necesario hacer hasta ese punto cuando llegue la segunda persona en el...