¿Qué son las especificaciones técnicas? ¿Son lo mismo que los documentos de diseño? Si no, ¿cuál es la diferencia y algunos
Trabajo como parte de un equipo en una aplicación existente que no tiene documentación en línea, ni tampoco tiene documentación técnica. Como he estado trabajando en varios informes de errores en la aplicación, he escrito una especie de ruta de navegación para mí: números de errores en varios...
Estamos tratando de mover nuestro proceso de documentación del proyecto de Documentos de Google a un conjunto de repositorios Git autohospedados. Los documentos de texto son lo suficientemente amigables con Git, ya que generalmente no necesitamos ningún formato sofisticado, simplemente...
Mi empresa está buscando mejorar su gestión de datos de investigación de mercado. Estilo actual de gestión de datos: "Hola Jimbo, ¿dónde está esa foto de nuestro WhatZit 2.0? "Sí, recuerdo ese correo electrónico sobre esa compañía de ese tipo, dame unos minutos para buscar en mi Outlook" "¿Quién...
Actualmente soy pasante en un contratista del gobierno y tengo la sensación (desagradable) de que Word es el estándar de facto en el proceso de desarrollo de software. Su formato binario hace que sea muy difícil colaborar en documentos de la manera en que estoy acostumbrado a colaborar en una base...
¿Cuándo comenzaron las personas a escribir archivos Léame? Parece que casi todos los programas tienen este archivo, independientemente del formato. ¿Hay algún primer uso documentado de este
Hay algunos buenos ejemplos de código bien documentado, como java api. Pero, una gran cantidad de código en proyectos públicos, como git y proyectos internos de empresas, está mal documentado y no es muy amigable para los recién llegados. En todos mis períodos de desarrollo de software, he tenido...
En mi lugar de trabajo, nos enfrentamos a un desafío porque "ágil" con demasiada frecuencia ha significado "requisitos vagos, malos criterios de aceptación, ¡buena suerte!" Estamos tratando de abordar eso, como un esfuerzo de mejora general. Entonces, como parte de eso, propongo que generemos...
El desarrollo basado en el comportamiento con su emblemática sintaxis de escenarios "dado-cuándo-entonces" últimamente ha sido muy publicitado para sus posibles usos como un objeto límite para la evaluación de la funcionalidad del software. Definitivamente estoy de acuerdo en que Gherkin , o la...
¿Por qué la documentación en algunos idiomas dice "equivalente a" en lugar de "es"? Por ejemplo, los documentos de Python dicen itertools.chain(*iterables) ... Equivalente a: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield...
He estado trabajando en un proyecto durante un par de años y estoy empezando a reunir una base de usuarios decente. He creado una página de proyecto con documentación básica, pero en este momento no es mucho más que una pregunta frecuente. Sé que necesito mejorarlo para que sea más informativo para...
No puedo contar el número de veces que leo declaraciones en la línea de "las pruebas unitarias son una fuente muy importante de documentación del código bajo prueba". No niego que sean ciertas. Pero personalmente no me he encontrado usándolos como documentación, nunca. Para los marcos típicos que...
Cerrada . Esta pregunta necesita estar más centrada . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que se centre en un problema solo editando esta publicación . Cerrado el año pasado . Quiero...
Parece un poco controvertido el tema de documentar todo, incluida la sintaxis "JavaBean" de captadores y establecedores para campos: la gente dice que es innecesariamente largo y repetitivo romper SECO (no repetir) , que la convención de nomenclatura debería explicar todo , y satura el código /...
Actualmente estamos escribiendo especificaciones funcionales y técnicas en un formato de dos columnas; oración resumida y detalles técnicos. Los detalles a menudo se refieren a un apéndice con diagramas, diseños de diseño, etc. Sin embargo, estoy luchando con el tiempo para escribirlo: Con el...
Antecedentes: mis colaboradores y yo estamos escribiendo un artículo para una revista académica. En el curso de nuestra investigación, escribimos un programa de simulación en Java. Queremos que el programa de simulación esté disponible gratuitamente para que otros lo usen. Hemos decidido alojar el...
Entonces tenemos una interfaz como esta /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff ///...
A veces, aunque no con frecuencia, tengo que incluir la lógica matemática en mi código. Los conceptos utilizados son en su mayoría muy simples, pero el código resultante no lo es: muchas variables con un propósito poco claro y algunas operaciones con una intención no tan obvia. No quiero decir que...
Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 6 años . Después...
Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 5 años . Todos...