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 importante capturar la lógica para que …

13 design  documentation 

Estoy buscando un formato de documentación de clase informativo para mis clases de Entidad, Lógica empresarial y Acceso a datos. Encontré los siguientes dos formatos desde aquí Formato 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// …

13 c#  documentation  comments 

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 por desarrolladores que trabajaron …

13 project-management  documentation 

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 …

13 documentation  uml  nosql  mongodb  diagrams 

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 (RFC) es un memorando publicado por Internet Engineering Task Force (IETF) que …

12 learning  documentation 

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 un administrador de software, que es …

12 design  project-management  development-process  documentation 

¿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. …

12 documentation  terminology  api  documentation-generation  javadocs 

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 programadores que tienden a …

12 project-management  agile  documentation 

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 otras: Manuales (obviamente) ¿Notas …

12 documentation  terminology 

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 está a punto de adquirir un código fuente de un …

12 documentation  maintenance  knowledge-transfer 

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 problema?

12 documentation  definition 

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 es algo …

12 documentation  html  help-documentation 

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 de un creciente proyecto de código abierto. Actualmente, me …

12 open-source  documentation 

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 …

12 documentation  project  management  requirements 

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 que termino un proyecto, siempre hay algo que …

12 experience  documentation  journal