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 . Estamos en...
Si tengo un código que es matemáticamente o estructuralmente bastante complejo e irreductible, ¿cómo haría para documentar este código? En particular, ¿cómo puedo asegurarme de que alguien que no tenga las habilidades matemáticas o arquitectónicas que yo pueda entenderlo de la documentación? ¿Debo...
Estaba (casualmente) investigando enfoques semánticos / ontológicos de documentación técnica, cuando me topé con esta gema : La programación literaria y la web semántica son ideas de diferentes épocas, que tienen una conexión. El documento vinculado, Literate Programming in XML de Norman...
Primero, me doy cuenta de que esta pregunta puede ser algo larga y vaga y me disculpo por esto. Este es probablemente un problema básico con un nombre corto para cualquiera que lo haya "entendido", pero como me parece que me falta en este sentido, tenga paciencia para describir el problema. He...
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...
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 línea XYZ que...
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 documentación. Varios...
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...
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...
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...
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
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 . Mi...
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 4 años . ¿Qué...
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 2 años . Estoy en...
He desarrollado algunas bibliotecas cuantitativas en C # donde es importante comprender no solo la información clásica que acompaña a los comentarios XMLDoc (que contiene información básica con la firma del método) sino también las fórmulas matemáticas que se utilizan dentro de los métodos. Por lo...
Un colega mío estuvo una vez en un seminario sobre desarrollo ágil, donde escuchó que es posible usar pruebas unitarias como documentación técnica. Algo así como usar pruebas unitarias como un ejemplo de cómo usar la clase. Una búsqueda rápida en Google proporcionó TDD y documentación , lo que...
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 4 años . Recientemente me...
¿Cuál sería una buena alternativa a la documentación en línea de Java, es decir, puede uno tener un archivo de documentos separado de alguna manera asignado a un archivo fuente de Java? Nunca me han gustado las grandes secciones de comentarios llenas de
Actualmente estoy trabajando en una implementación establecida en JavaScript. Esto debería simular genéricos como se conoce de Java o C #. Necesito una versión mutable de eso (permite agregar / eliminar valores establecidos) y una inmutable. Mi firma de constructor se ve así: new GenericSet(...
Estoy tratando de documentar una pieza de software que escribí en detalle. Un SAS tiene un nivel demasiado alto y no cubre la API. Encontré varios ejemplos de una SDS en línea, pero no veo una tendencia en su formato. Me pregunto si hay algunas pautas generales para escribir una especificación de...