Quali blocchi stradali devono affrontare il processo di sviluppo nell'uso di linguaggi di markup in testo semplice rispetto, ad esempio, a Microsoft Word? [chiuso]

Attualmente sono stagista presso un appaltatore governativo e ho la sensazione (odiosamente inevitabile) che Word sia lo standard di fatto nel processo di sviluppo del software.

Il suo formato binario rende molto difficile collaborare ai documenti nel modo in cui sono abituato a collaborare su una base di codice. L'uso del markup di testo semplice (con linguaggi come LaTeX, Markdown, ReStructured Text, ecc. ) Consente un documento diff-friendly che funziona bene con il normale flusso di lavoro di uno sviluppatore. Per quanto riguarda i commenti in cui la lingua non li supporta (ad esempio Markdown), ci sono molte soluzioni esistenti che consentono commenti collaborativi su basi di codice (ad esempio GitHub, Bitbucket) che potrebbero essere facilmente applicati ad altri file di testo semplice contenenti markup.

Comprendo la necessità di collaborare con la gestione tecnologicamente analfabeta richiede una sorta di interfaccia grafica per tutto, ma tali interfacce esistono per la maggior parte di questi formati. Ad esempio, LaTeX ha una sorta di "fork" di tipo chiamato LyX che inserisce un front-end grafico in una sintassi di testo semplice, simile a LaTeX. Questo file, anche se principalmente grafico nella sua modifica, è ancora diff-friendly. (Ha anche commenti in stile Word.) Molte di queste soluzioni potrebbero essere ancora utilizzate al posto di Word, e la stragrande maggioranza è gratuita o open-source.

Tuttavia, utilizziamo Word anche per la nostra documentazione interna che nessun altro vede. Lavoriamo con il testo per una parte significativa della nostra carriera --- perché la documentazione è così speciale? A parte il banale "Non sapevamo niente di meglio e ora siamo bloccati qui", ci devono essere ragioni a sostegno di tale decisione. Quali sono le sfide che il processo di sviluppo del software deve affrontare nell'usare la documentazione di testo in chiaro al posto di altri mezzi più colloquiali (e indebitamente meno potenti) per scrivere documenti?

Dal momento che le ragioni saranno diverse, forse la risposta a questi due scenari strettamente correlati separatamente dovrebbe essere in ordine.

• Utilizzo della documentazione in testo semplice dall'inizio
• Migrazione alla documentazione in chiaro nel tempo

Molti partecipanti al processo di sviluppo del software non sono sviluppatori e devono comunque interagire con la documentazione. Il QA / Marketing dovrebbe usare la parola e gli sviluppatori dovrebbero usare qualcos'altro completamente? Sarebbe incoerente, aggiungerebbe un altro strumento nella catena di manutenzione e la parte IT di un'azienda potrebbe non avere idea di cosa fare con i file, quando sanno perfettamente come gestire / mantenere un archivio di documenti word.

Soprattutto, molti non sviluppatori hanno trascorso anni all'università usando Microsoft Word per trasformare il loro lavoro, spesso avendo avuto veri e propri corsi di formazione su come usare la parola. Lo sanno molto meglio delle alternative. Riesco a malapena a capire la differenza quando lavoro in Open Office vs Word, ma quando mia cognata la usava per risparmiare denaro, una settimana dopo fece in modo che suo marito comprasse la sua parola e proclamasse "Da quando ho ricevuto la parola che amo il mio nuovo laptop! ". Pensa alla mentalità che unisce cose del genere, un leggero cambiamento in ciò a cui sono abituati non è "leggero" per loro.

La parola moderna consente differenze di versione, annotazioni con rilevamento della versione e modifica delle fusioni. Potrebbe non essere così semplice come la fusione del codice, ma ho visto molti project manager farlo facilmente, quindi sicuramente gli sviluppatori possono riuscire a farlo anche.

Oltre a ciò, è diventato abbastanza comune tra i team di sviluppatori fare documentazione in wiki perché torna alla rappresentazione testuale rimanendo abbastanza semplice da consentire ai non sviluppatori di apportare modifiche.

Personalmente penso che sia un problema di educazione.

Molte persone sono state indotte a pensare che l'uso di uno strumento come MS Word rende più semplice la produzione di documenti di qualità, ma da quello che ho visto in realtà lo rende più difficile. Alla fine devi eseguire il debug della formattazione all'infinito e combattere i tuoi strumenti per ottenere il risultato che desideri.

Strumenti come Scrivener ti consentono di avvicinarti un po 'alla realtà del documento senza doverlo combattere come fai con Word. In parte a causa della realizzazione, il WYSIWYG in realtà non funziona molto bene.

Nella mia organizzazione, più persone passerò a utilizzare MarkDown per la maggior parte dei loro bisogni di documenti, più persone saranno più felici e produttive.

Hai davvero 2 domande:

Primo: perché i gruppi non di sviluppo non usano LaTeX o altri Markdown nel processo di sviluppo del software?

Il problema con la migrazione a LaTeX è la curva di apprendimento percepita, in particolare quando si ha a che fare con utenti non tecnici. Gli utenti conoscono già altri formati e non vogliono imparare un altro metodo per fare la stessa cosa che hanno fatto. Sanno poco o niente su come diff 2 documenti e quindi c'è poco valore nel passare a un formato basato su testo per loro. Spiegare a una persona che hai una soluzione per un problema che non sapeva di avere è una vendita piuttosto difficile.

Inoltre, non puoi sottovalutare il valore dello slancio in avanti. Per migrare in un nuovo formato devi davvero convincere altre persone nella tua catena che vale la pena investire nell'imparare qualcosa di nuovo. Anche se non ti aspetti che modifichino nulla, ci vuole tempo e molta fatica per migrare in un nuovo formato quando un formato esistente funziona (anche se in modo scadente).

La seconda domanda: perché il mio team continua a utilizzare documenti Word quando ci sono opzioni migliori e sono più che in grado di impararli?

Questo è qualcosa di cui dovresti parlare con le persone della tua squadra. Potrebbero esserci validi motivi per cui scelgono di conservare documenti in formato word o potrebbe essere solo perché è sempre stato così.

Ci sono costi associati a qualsiasi modifica e può essere costoso e richiedere tempo per spostare centinaia o migliaia di documenti in un nuovo formato. Se stai per provare a cambiare il tuo ambiente, aspettati di fare un caso per cui dovresti cambiare