Preguntas etiquetadas con documentation

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 Walsh, analiza las tecnologías XML que son centrales …

9 documentation  semantic-web  literate-programming 

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 documentar todas las matemáticas también? Enlace a …

9 documentation 

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 …

9 documentation  design  modeling 

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 una mala situación de tener muy poca documentación sobre la …

9 documentation 

Quiero escribir Javadoc en SECO. Pero el documento de Oracle sobre Javadoc dice escribir lo mismo nuevamente en el comentario del método de sobrecarga. ¿No puedo evitar la repetición?

9 documentation  comments  dry  javadocs 

Estoy tomando mi primera aplicación de nivel empresarial y quiero que mi equipo modele toda la aplicación ASP.NET MVC C # incluso antes de que toquemos una línea de código. ACTUALIZACIÓN: Esto no pretendía ser una discusión filosófica sobre cuándo documentar / modelar una aplicación. Solo proporcione respuestas para "cómo" …

9 c#  asp.net-mvc  documentation  uml 

Entonces está solucionando errores, luego encontró uno que podría afectar a otros módulos del producto de software. Sus datos no son suficientes para respaldar su reclamo sobre los efectos de la corrección y se le pidió que creara un documento de análisis de impacto. ¿Hay un proceso definido sobre cómo …

9 project-management  documentation 

Estoy buscando formas de mejorar la gestión de requisitos. Actualmente, tenemos un documento de Word publicado en un sitio web. Desafortunadamente, no podemos (que yo sepa) mirar los cambios de una revisión a la siguiente. Preferiría poder hacerlo, al igual que con un wiki o VCS (¡o ambos, como el …

9 documentation  project-management  wiki  requirements 

Esta podría ser una pregunta estúpida, pero ha estado en mi cabeza por un tiempo y no puedo encontrar una respuesta decente en ningún otro lado. Tengo un maestro que dice que deberíamos enumerar explícitamente cada parámetro con una descripción, incluso si solo hay uno. Esto lleva a mucha repetición: …

9 documentation  comments  coding-style 

¿Alguien tiene sugerencias para crear una representación de diagrama de flujo de una interfaz web de estilo REST? En el interés de proporcionar documentación exhaustiva a los co-desarrolladores, he estado jugando en el dia modelado de la interfaz para modificar y generar un recurso de producto: Este sistema en particular …

9 documentation  rest  flowchart 

Soy desarrollador de software en una empresa de tecnología. Me encargaron liderar el esfuerzo de documentación del producto en el que trabajo. El objetivo es producir documentación interna para el desarrollador, y el proyecto se extiende al lado comercial, donde cubre la documentación de requisitos. Este proyecto es desafiante. Específicamente, …

9 development-process  documentation  teamwork  planning 

Creo que uno de los mayores puntos débiles al trabajar con microservicios es asegurarse de que las API estén bien documentadas y que las API no cambien su comportamiento sin afectar las aplicaciones posteriores. Este problema se amplifica cuando tiene muchos servicios que son interdependientes entre sí. Quizás en ese …

8 api-design  documentation  microservices 

Tenemos como 20-30 módulos / soluciones independientes. Cada uno de estos tiene entre 7 y 10 proyectos con diferentes clases, componentes, etc. Todos estos se utilizan internamente en nuestra empresa. Nuestro problema es que cuando hacemos un cambio en un módulo, debemos asegurarnos de actualizar todos los demás módulos que …

8 documentation  api  configuration-management  change-management 

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 . Comencé a trabajar en una gran empresa de software y …

8 documentation  refactoring  management  business  development-environment 

Crear una biblioteca C ++ también significa documentarla para que otros puedan usarla, y esa documentación puede variar drásticamente en calidad. ¿Cómo debe estructurarse un sitio web para una biblioteca C ++ para que sea más efectivo? Enmarcaría "más eficaz" como dividido entre tres grupos específicos de interesados ​​de la …

8 c++  documentation