Preguntas etiquetadas con documentation

Uno de los objetivos principales de las empresas de desarrollo de software es aumentar su factor Bus. Esto también es defendido en una charla organizada por Google . Eso significa que debe codificar y documentar todo de una manera que si mañana lo atropella en autobús, el proyecto aún puede …

48 documentation  clean-code 

Parece haber una aversión a escribir incluso la documentación más básica. Nuestro proyecto READMEs es relativamente simple. Ni siquiera hay listas actualizadas de dependencias en los documentos. ¿Hay algo que desconozco en la industria que haga que a los programadores no les guste escribir documentación? Puedo escribir párrafos de documentos …

47 documentation  teamwork 

Cuando trabajo en código, enfrento muchos de los mismos desafíos que enfrentan mis compañeros de equipo, y he escrito algunas funciones y clases útiles, y ellos también. Si hay una buena comunicación, escucharé sobre algo genial que alguien armó, y seis meses después, cuando lo necesite, lo recordaré y llamaré …

43 documentation  teamwork  team  code-reuse 

Me encuentro escribiendo (con suerte) comentarios útiles en la documentación del código (C ++) del tipo: The reason we are doing this is... La razón por la que uso "nosotros" en lugar de "yo" es porque hago mucha escritura académica donde a menudo se prefiere "nosotros". Así que aquí está …

41 documentation 

El programa de CS de mi escuela evita cualquier mención de programación orientada a objetos, por lo que he estado leyendo un poco para complementarlo, específicamente, Construcción de software orientado a objetos por Bertrand Meyer. Meyer señala repetidamente que las clases deben ocultar tanta información sobre su implementación como sea …

39 design  object-oriented  documentation  performance 

¿Qué son las especificaciones técnicas? ¿Son lo mismo que los documentos de diseño? Si no, ¿cuál es la diferencia y algunos ejemplos?

38 documentation  specifications 

Estamos tratando de mover nuestro proceso de documentación del proyecto de Documentos de Google a un conjunto de repositorios Git autohospedados. Los documentos de texto son lo suficientemente amigables con Git, ya que generalmente no necesitamos ningún formato sofisticado, simplemente convertiremos todo a, por ejemplo, multimarkdown con una opción para …

35 version-control  documentation  tools  linux 

Mi empresa está buscando mejorar su gestión de datos de investigación de mercado. Estilo actual de gestión de datos: "Hola Jimbo, ¿dónde está esa foto de nuestro WhatZit 2.0? "Sí, recuerdo ese correo electrónico sobre esa compañía de ese tipo, dame unos minutos para buscar en mi Outlook" "¿Quién tiene …

35 documentation  cms  wiki 

Trabajo como parte de un equipo en una aplicación existente que no tiene documentación en línea, ni tampoco tiene documentación técnica. Como he estado trabajando en varios informes de errores en la aplicación, he escrito una especie de ruta de navegación para mí: números de errores en varios lugares para …

35 documentation  language-agnostic  methodology 

Actualmente soy pasante en un contratista del gobierno y tengo la sensación (desagradable) de que Word es el estándar de facto en el proceso de desarrollo de software. Su formato binario hace que sea muy difícil colaborar en documentos de la manera en que estoy acostumbrado a colaborar en una …

33 development-process  documentation 

¿Cuándo comenzaron las personas a escribir archivos Léame? Parece que casi todos los programas tienen este archivo, independientemente del formato. ¿Hay algún primer uso documentado de este documento?

32 documentation  terminology  history 

Hay algunos buenos ejemplos de código bien documentado, como java api. Pero, una gran cantidad de código en proyectos públicos, como git y proyectos internos de empresas, está mal documentado y no es muy amigable para los recién llegados. En todos mis períodos de desarrollo de software, he tenido que …

26 programming-practices  development-process  documentation  source-code  sdlc 

En mi lugar de trabajo, nos enfrentamos a un desafío porque "ágil" con demasiada frecuencia ha significado "requisitos vagos, malos criterios de aceptación, ¡buena suerte!" Estamos tratando de abordar eso, como un esfuerzo de mejora general. Entonces, como parte de eso, propongo que generemos documentos de diseño que, más allá …

25 design  agile  documentation 

El desarrollo basado en el comportamiento con su emblemática sintaxis de escenarios "dado-cuándo-entonces" últimamente ha sido muy publicitado para sus posibles usos como un objeto límite para la evaluación de la funcionalidad del software. Definitivamente estoy de acuerdo en que Gherkin , o la secuencia de comandos de definición de …

24 documentation  bdd  documentation-generation  business-rules 

He estado trabajando en un proyecto durante un par de años y estoy empezando a reunir una base de usuarios decente. He creado una página de proyecto con documentación básica, pero en este momento no es mucho más que una pregunta frecuente. Sé que necesito mejorarlo para que sea más …

23 documentation