¿Qué obstáculos enfrenta el proceso de desarrollo al usar lenguajes de marcado de texto plano en lugar de, por ejemplo, Microsoft Word? [cerrado]

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 base de código. El uso de marcado de texto sin formato (con lenguajes como LaTeX, Markdown, ReStructured Text, etc. ) permite un documento fácil de usar que funciona bien con el flujo de trabajo normal de un desarrollador. En cuanto a los comentarios donde el lenguaje no los admite (por ejemplo, Markdown), existen muchas soluciones existentes que permiten comentarios de colaboración sobre bases de código (por ejemplo, GitHub, Bitbucket) que podrían aplicarse fácilmente a otros archivos de texto sin formato que contienen marcado.

Entiendo que la necesidad de cooperar con la administración de analfabetos tecnológicos requiere algún tipo de interfaz gráfica para todo, pero tales interfaces existen para la mayoría de estos formatos. Por ejemplo, LaTeX tiene una especie de "bifurcación" llamada LyX que coloca un front-end gráfico en una sintaxis de texto plano similar a LaTeX. Este archivo, aunque es principalmente gráfico en su edición, sigue siendo fácil de usar. (Incluso tiene comentarios al estilo de Word). Muchas de estas soluciones aún podrían usarse en lugar de Word, y la gran mayoría son gratuitas o de código abierto.

Sin embargo, utilizamos Word incluso para nuestra propia documentación interna que nadie más ve. Trabajamos con texto para una parte importante de nuestra carrera --- ¿por qué la documentación es tan especial? Aparte del trivial "No sabíamos nada mejor y ahora estamos atrapados aquí", debe haber razones que respalden dicha decisión. ¿Qué desafíos enfrenta el proceso de desarrollo de software al usar documentación de texto plano en lugar de otros medios más coloquiales (y discutiblemente menos poderosos) para escribir documentos?

Dado que las razones serán diferentes, quizás sea necesario responder a estos dos escenarios estrechamente relacionados por separado.

Usar documentación de texto sin formato desde el principio
Migrar a la documentación de texto sin formato a lo largo del tiempo

development-process documentation

— Sean Allred
fuente

Por razones independientes, sería aconsejable migrar a versiones más recientes de Word (Office 2007 / 12.0 y superior) cuyos formatos de documentos se basan en XML. Las versiones actualizadas de openoffice y especialmente libreoffice podrían ser una opción aún mejor: los filtros de importación / exportación permiten una integración perfecta con un flujo de trabajo basado en palabras de ms. Más concretamente, trabajar con lenguajes de marcado en la configuración de páginas exige un mayor nivel de abstracción y una mejor estructuración de las ideas de antemano, mientras que no es fácilmente compatible con la escritura exploratoria. y, por supuesto, la interfaz de usuario de ms office es habitual, no se requiere capacitación.

— collapsar

No estoy seguro de estar de acuerdo con su premisa: estoy seguro de que hay muchos lugares en uno u otro de los lenguajes de marcado, debido a los beneficios que usted describe.

— vaughandroid

Como colapsar señaló, los documentos de palabras basados en XML son muy fáciles de programar para (openxml sdk, ... (puedo aconsejar ClosedXML y Novasoft.DocX para c #). uno lo usa, es tan bueno como muerto. ¡La curva de aprendizaje es demasiado alta! Tu madre y tu abuela probablemente saben qué palabra es. ¡Pregúntales sobre TEX, me sorprendería!

— Mvision

Y en cuanto a que la interfaz de usuario sea intuitiva, esto es cierto para una buena parte del flujo de trabajo de nivel de cliché normal, pero se desglosa para cualquier cosa más compleja. Visite superuser.com/questions/620454 y también tenga en cuenta que la forma de actualizar una tabla de contenido es insertar una nueva en el medio y esperar la ventana emergente. La forma de ignorar constantemente la ortografía de un fragmento de texto es establecer el idioma <-null. ¿Algo de esto es intuitivo? Pero esto está fuera del punto. El texto sin formato expone completamente la estructura y el contenido del documento; sin desorden, sin problemas.

— Sean Allred

@rath Absolutamente. Si alguien espera traer algunas mentes jóvenes al lado oscuro, los comentarios / respuestas a los enlaces deberían ayudarlo a comenzar. (Especialmente la presentación de Jubobs --- subió un archivo y es muy bueno.)

— Sean Allred

Respuestas:

Muchos participantes en el proceso de desarrollo de software no son desarrolladores, y necesitan la capacidad de interactuar con la documentación independientemente. ¿Debería QA / Marketing usar palabras y los desarrolladores deben usar algo completamente diferente? Sería inconsistente, agregaría otra herramienta a la cadena de mantenimiento y la parte de TI de una empresa puede no tener idea de qué hacer con los archivos, cuando saben completamente cómo administrar / mantener un almacén de documentos de Word.

Por encima de todo, muchos no desarrolladores han pasado años en la universidad usando Microsoft Word para entregar su trabajo, con frecuencia habiendo tenido clases de capacitación reales sobre cómo usar Word. Lo saben mucho mejor que las alternativas. Difícilmente puedo notar la diferencia cuando estoy trabajando en Open Office vs Word, pero cuando hice que mi cuñada lo usara para ahorrar dinero, una semana después hizo que su esposo comprara su Word y proclamó "Desde que recibí la palabra me encanta mi nueva laptop ". Piensa en la mentalidad que combina cosas así, un ligero cambio en lo que están acostumbrados no es "leve" para ellos.

La palabra moderna permite diferencias de versiones, anotaciones con seguimiento de versiones y fusión de cambios también. Puede que no sea tan sencillo como fusionar código, pero he visto que muchos gerentes de proyecto lo hacen fácilmente, por lo que seguramente los desarrolladores también pueden hacerlo.

Más allá de eso, se ha vuelto bastante común entre los equipos de desarrollo hacer documentación en wikis porque vuelve a la representación textual mientras se mantiene lo suficientemente simple como para que los no desarrolladores puedan realizar ediciones.

— Jimmy Hoffa
fuente

En parte, no estoy de acuerdo con su segundo párrafo: la mayoría de las personas con las que trabajo no tienen idea de cómo usar Word y otras cosas. Y generalmente se siente incómodo con algo que no se parece a algo que saben (¿cintas a alguien? ;-)). Esto significa que uno podría imponer cualquier cosa sobre ellos. El resto lo resume bastante bien por desgracia.

— nietonfir

@nietonfir wow, según mi experiencia, esa palabra es la herramienta favorita de todas las personas PM y QA (solo lectura)

— Jimmy Hoffa

@JimmyHoffa lo es, pero la mayoría no sabe cómo usar Word correctamente (por ejemplo, índice, subtítulos de imágenes, encabezados de primera página, numeraciones, encabezados, ...).

— nietonfir

@JimmyHoffa: Sí, pero ¿cuánto entrenamiento obtuvieron para ello? ¿Y qué cantidad de funciones de Word utilizan realmente? En mi humilde opinión, la mayoría de estos usuarios podrían cambiar fácilmente a WordPad.

— Restablecer Monica - M. Schröder

Oh, hola, @ MartinSchröder :-) En cuanto a WordPad, mientras que la mayoría de los escritores de contenido pueden no saber cómo usar MS Word en todo su 'potencial', algunos lo hacen . Desde mi experiencia, es un pequeño conjunto de usuarios avanzados que configuran un documento (una y otra vez) para los usuarios que realmente agregan la mayor parte del contenido. Cuando alguien quiere agregar una figura, se agrega un comentario. (El mantenimiento del documento como documento , entonces, se convierte en al menos un trabajo de medio tiempo.)

— Sean Allred

Personalmente creo que es una cuestión de educación.

Se ha engañado a la mayoría de las personas para que piensen que usar una herramienta como MS Word hace que sea más fácil producir documentos de calidad, pero por lo que he visto en realidad lo hace más difícil. Termina teniendo que depurar el formato sin fin y luchar contra sus herramientas para obtener el resultado que desea.

Herramientas como Scrivener le permiten acercarse un poco más a la realidad del documento sin tener que luchar contra él como lo hace con Word. En parte debido a la realización, el WYSIWYG en realidad no funciona muy bien.

En mi propia organización, cuantas más personas me mude a usar MarkDown para la mayoría de sus documentos, más personas serán más felices y más productivas.

— aboy021
fuente

¿Estás sugiriendo realmente que es más fácil "depurar" LaTeX que MS Word?

— user253751

@immibis LaTeX3 sabe que esto es un problema (incluso LaTeX2e, pero no logró transmitir el punto). Idealmente, no se realiza ninguna codificación en el nivel del documento (expuesto al autor). Toda la 'depuración' se realiza en el nivel de código, donde hay personas que están familiarizadas con el idioma que hacen ese trabajo. Confía en mí, expl3los mensajes de error son mucho más útiles :)

— Sean Allred

@immibis De hecho, es más fácil "depurar" LaTeX que MSWord. Hay peculiaridades de formato en MSWord que nadie puede solucionar sin modificar el programa MSWord. En esos casos, puede tomar todo el tiempo que necesite para aprender LaTeX -> TeX -> C -> Assembler, por más profundo que necesite ir. Conozco usuarios fuera del campo de desarrollo de software que tienen un buen conocimiento práctico sobre LaTeX y cosas como pstricks. Escogen LaTex sobre Word cada vez. Ellos usu. no realiza muchas depuraciones complejas, solo le pide ayuda a alguien, lo que para ellos ocurre con menos frecuencia que con MSWord.

— wolfmanx

Realmente tienes 2 preguntas:

Primero: ¿Por qué los grupos que no son de desarrollo no usan LaTeX u otro Markdown en el proceso de desarrollo de software?

El problema con la migración a LaTeX es la curva de aprendizaje percibida, especialmente cuando se trata de usuarios no técnicos. Los usuarios ya conocen otros formatos y no quieren tener que aprender otro método para hacer lo mismo que estaban haciendo. Saben poco o nada acerca de cómo diferenciar 2 documentos, por lo que tiene poco valor cambiar a un formato basado en texto para ellos. Explicarle a una persona que tiene una solución para un problema que no sabía que tenía es una venta bastante difícil.

Tampoco puedes subestimar el valor del impulso hacia adelante. Para migrar a un nuevo formato, realmente tiene que convencer a otras personas en su cadena de que vale la pena invertir en aprender algo nuevo. Incluso si no espera que editen nada, lleva tiempo y mucho esfuerzo migrar a un nuevo formato cuando un formato existente funciona (aunque sea deficiente).

La segunda pregunta: ¿por qué mi equipo continúa usando documentos de Word cuando hay mejores opciones y son más que capaces de aprenderlas?

Esto es algo de lo que deberías hablar con las personas de tu equipo. Puede haber razones válidas por las que eligen mantener documentos de Word o puede ser porque esa es la forma en que siempre se ha hecho.

Hay costos asociados con cualquier cambio y puede ser costoso y llevar mucho tiempo mover cientos o miles de documentos a un nuevo formato. Si va a intentar cambiar su entorno, espere tener que justificar por qué debería cambiar

— Stoj
fuente

esto ni siquiera intenta responder a la pregunta formulada, "¿Por qué los lenguajes de marcado de texto plano (como LaTeX o Markdown) son más populares en el proceso de desarrollo de software?"

— mosquito

+0, pero estuvo de acuerdo: esto sería más apropiado como comentario.

— Sean Allred

Después de la primera edición de la pregunta, se ha vuelto mucho mejor. @gnat, otra mirada está en orden.

— Sean Allred