Preguntas etiquetadas con documentation

Una parte central del diseño impulsado por dominio es el uso constante de un lenguaje ubicuo en todo el sistema: en conversaciones, código, esquema de base de datos, interfaz de usuario, pruebas, etc. Estoy involucrado en un proyecto en el que ya existe un lenguaje de dominio bien establecido, definido …

10 documentation  domain-specific-languages 

Me parece que no es posible escribir una especificación de software en inglés que esté completamente libre de ambigüedades, simplemente debido a la naturaleza informal del lenguaje natural, y por lo tanto, una especificación verdaderamente inequívoca debe incluir código escrito en un lenguaje formalmente especificado. ¿Es este un resultado conocido …

10 documentation  specifications 

Soy uno de esos desarrolladores que tiene la mentalidad de que el código escrito debe explicarse por sí mismo y leerse como un libro. SIN EMBARGO, cuando desarrollo código de biblioteca para que otras personas lo usen, trato de poner tanta documentación en los archivos de encabezado como sea posible; …

10 c++  documentation 

Es difícil saber qué se pregunta aquí. Esta pregunta es ambigua, vaga, incompleta, demasiado amplia o retórica y no se puede responder razonablemente en su forma actual. Para obtener ayuda para aclarar esta pregunta y poder volver a abrirla, visite el centro de ayuda . Cerrado hace 8 años . …

10 agile  documentation  methodology 

Cerrado. Esta pregunta está fuera de tema . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que sea sobre el tema de Software Engineering Stack Exchange. Cerrado hace 6 años . Nuestro software interno se ha utilizado para muchos usuarios y el departamento de capacitación …

10 design  documentation  users 

He documentado mi código doxygen, pero no quiero el HTML predeterminado que proporciona. Sé que puedo personalizarlo al proporcionar CSS personalizado, encabezados, pies de página, etc. (como lo hace GNOME), y cómo puedo agregar código PHP común a los archivos y decirle que guarde como .php, pero eso no es …

10 documentation  templates  documentation-generation 

Me pregunto qué debería contener la documentación de un algoritmo. No se puede encontrar una directriz adecuada para seguir. Tengo en mente incluir resumen del algoritmo descripción del algoritmo diagramas de flujo pseudocódigos conjunto de datos de entrada de muestra (múltiple) datos resultantes pruebas unitarias experimentos El cliente solicita dicha …

10 java  php  algorithms  documentation  sql 

Tenemos muchos documentos asociados con nuestro desarrollo de software. Estos incluyen cosas como requisitos, documentos de diseño, archivos PDF externos, archivos de clientes, instrucciones de prueba, etc. Actualmente, estos documentos están dispersos por todas partes (wiki, "algún lugar en la red", un disco duro de desarrolladores locales (!), e incluso …

10 version-control  documentation 

Al revisar de otro programador implementación de una función para calcular la CDF distribución normal , hice una sugerencia para reemplazar toda la implementación de Python con funciones integradas o utilizar SciPy, una biblioteca científica común. Otro programador señaló que math.erfc()ni scipy.stats.norm.cdf()proporciona garantías de precisión en su documentación. Por lo …

9 documentation  math  floating-point  numeric-precision 

A menudo me encuentro resolviendo errores al encontrar la respuesta en Stack Overflow. ¿Es una mala práctica agregar un fragmento de por qué hice lo que hice y luego agregar un enlace a un artículo o página de la web?

9 documentation 

Estoy trabajando en una pequeña biblioteca que proporciona implementaciones de métricas de cadena básicas y bien conocidas. Principalmente para mi propia educación. Entonces, el desarrollo ocurre cada vez que tengo un poco de tiempo libre. Debido a esto, he automatizado la mayoría de los procesos para poder lanzar una versión …

9 java  documentation  javadocs 

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 hace 4 años . ¿Por qué aún incorporamos descripciones en lenguaje natural del código fuente (es …

9 development-process  documentation  source-code 

Esto se refiere a una discusión en una respuesta y los comentarios de esta pregunta: ¿Qué pasa con la aversión a la documentación en la industria? . La respuesta afirmaba que "el código no puede mentir" y, por lo tanto, debería ser la ubicación de acceso en lugar de la …

9 documentation 

Estoy a punto de abandonar un proyecto, y antes de irme, mi jefe me ha pedido que documente el código (no lo he documentado muy bien). No es gran cosa, el proyecto no es terriblemente complejo. Pero estoy encontrando lugares en mi documentación donde me gustaría decir: "Observe en la …

9 documentation  comments 

Estoy interesado en ver cómo otras personas hacen esto. Especialmente en situaciones en las que varios clientes diferentes utilizan la misma base de software con reglas comerciales ligeramente diferentes. ¿Qué tipo de prácticas utilizas para documentar cómo se supone que todo funciona o las reglas comerciales? Básicamente, cuando llega un …

9 documentation  business-rules