Preguntas etiquetadas con documentation

Actualmente estoy en el proceso de actualizar un documento de diseño para que sea correcto y actualizado para futuros desarrolladores. Actualmente, el documento se centra solo en los hechos, presentando cómo es el diseño. No hay justificación para ninguna decisión presentada. Creo que es...

Me gustaría saber qué opciones están disponibles para documentar un proyecto que ya se ha desarrollado, ya que los desarrolladores que trabajaron no escribieron ni una sola página de documentación. El proyecto no tiene más detalles que muchas páginas de scripts con funciones escritas y modificadas...

Tengo una base de datos MongoDB que deseo documentar correctamente su diseño de esquema. Sé que MongoDB es una base de datos NoSQL y no tiene esquemas por naturaleza, pero impongo un esquema a través de mi aplicación y quiero representarlo de una mejor manera que la impresión de un...

Actualmente estoy usando dos sistemas para escribir documentación de código (estoy usando C ++): La documentación sobre métodos y miembros de la clase se agrega al lado del código, utilizando el formato Doxygen. En un servidor, Doxygen se ejecuta en las fuentes para que la salida se pueda ver en...

W3Schools tiene la reputación de ser incompleto, a veces incorrecto y lleno de publicidad; aún así, cuando busca buscar algunas cosas o un enlace a la documentación al responder una pregunta de SO, sigue siendo el único recurso útil para varios navegadores. Hay otros recursos como la Red de...

¿Existe un buen término que sea similar pero diferente de "desaprobar" para significar que un método o API está en la base del código pero que no debe usarse porque su implementación no está completa o probablemente cambiará? (Sí, lo sé, esos métodos no deberían ser públicos, yada yada yada. No...

Cuando decimos 'documentación' para un producto de software, ¿qué incluye eso y qué no debería incluir? Por ejemplo, una pregunta reciente preguntó si los comentarios se consideran documentación. Pero también hay muchas otras áreas para las que esta es una pregunta válida, algunas más obvias que...

Estamos buscando renovar la documentación en nuestra línea de productos. Parte de eso incluye manuales de referencia para un lenguaje de programación utilizado como parte del sistema. Al escribir un manual de referencia para un lenguaje de programación, ¿cuál es la mejor manera de estructurarlo...

Importante : no tenemos ningún problema con la documentación del código fuente . Esto pertenece a la auditoría de código regular y se mantiene actualizado. Nuestro problema es con la documentación de los desarrolladores (o "externa" si lo desea), pequeños consejos tipo blog de programadores a...

Actualmente utilizamos un sistema llamado AsciiDoc que nos permite crear documentación en un simple marcado de texto. A partir de eso podemos generar múltiples formatos de salida. Solo utilizamos los formatos de salida pdf y chm. Me preguntaba si había una alternativa a chm? Lo que estoy buscando...

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 6 años . Soy el creador...

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 . Cada vez...

Soy un desarrollador de software que trabaja en una empresa de sistemas integrados. Tenemos un Gerente de Proyecto, que se encarga del cronograma general del proyecto (incluyendo electricidad, calidad, software y fabricación), por lo tanto, su cronograma de software es muy breve. También tenemos...

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 . Nuestra compañía...

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 6 años . Para un...

Cerrada . Esta pregunta necesita detalles o claridad . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Agregue detalles y aclare el problema editando esta publicación . Cerrado hace 4 años . RFC : Solicitud de comentarios...

Entiendo la diferencia entre los dos, pero mis colegas me preguntan sobre el beneficio de etiquetar los requisitos como funcionales o no funcionales (o de transición). ¿Por qué molestarse en hacerlo? Pasó lo que dijo que fue dos días revisando una lista de requisitos para un proyecto, y no vio...

Me pregunto cuál sería el método formal y más practicado para documentar las reglas de negocio. Además, ¿cómo documenta las especificaciones de la interfaz de usuario de los artefactos de desarrollo (por ejemplo, documentar campos de formulario y cómo se comportan los botones en el formulario,...

Tengo que documentar mi programa para un proyecto escolar y tenemos una sección llamada "dominio del problema", pero no tengo idea de qué discutir en esta sección. Entonces la pregunta es: ¿Qué debería discutirse en el dominio del

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 . Siempre me he...