Quali roadblock affrontano il processo di sviluppo utilizzando linguaggi di markup in testo normale anziché, ad esempio, Microsoft Word? [chiuso]

33

Attualmente sono stagista presso un appaltatore governativo e ho l'impressione (odiosamente inevitabile) che Word sia lo standard de facto nel processo di sviluppo del software.

Il suo formato binario rende molto difficile collaborare sui documenti nel modo in cui sono abituato a collaborare su un codice base. L'uso del markup in testo semplice (con linguaggi come LaTeX, Markdown, ReStructured Text, etc. ) 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 es. Markdown), ci sono molte soluzioni esistenti che consentono commenti collaborativi su basi di codice (es. GitHub, Bitbucket) che potrebbero facilmente essere applicate ad altri file di testo contenenti markup.

Capisco che 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 "forchetta" chiamata LyX che mette un front-end grafico su una sintassi simile a LaTeX. Questo file, anche se principalmente grafico nella sua modifica, è ancora diff-friendly. (Ha anche anche commenti in stile Word.) Molte di queste soluzioni potrebbero ancora essere utilizzate al posto di Word, e la maggior parte è gratuita o open-source.

Tuttavia, usiamo 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 sfide affrontano il processo di sviluppo del software nell'uso della documentazione in testo semplice al posto di altri mezzi, più colloquiali (e debatably meno potenti) di scrivere documenti?

Poiché i motivi saranno diversi, forse la risposta a questi due scenari strettamente correlati dovrebbe essere in ordine.

  • Utilizzo della documentazione in testo semplice dall'inizio
  • Migrazione alla documentazione di testo semplice nel tempo
posta Sean Allred 17.07.2013 - 17:07
fonte

3 risposte

43

Molti partecipanti al processo di sviluppo del software non sono sviluppatori e hanno bisogno della capacità di interagire con la documentazione a prescindere. Il QA / Marketing dovrebbe usare la parola e gli sviluppatori usare qualcos'altro completamente? Sarebbe incoerente, aggiungerebbe un altro strumento alla 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 di parole.

Soprattutto, molti non-sviluppatori hanno trascorso anni in università usando Microsoft Word per girare il loro lavoro, spesso avendo avuto lezioni di formazione reali su come usare la parola. Lo sanno molto meglio delle alternative. Difficilmente riesco a capire la differenza quando lavoro in Open Office vs Word, ma quando ho avuto la cognata di usarlo per risparmiare denaro, una settimana dopo ha fatto acquistare a suo marito la sua Parola e ha proclamato "Da quando ho avuto la parola che amo il mio nuovo laptop! ". Pensa alla mentalità che confonde cose del genere, un leggero cambiamento in ciò a cui sono abituati non è "leggero" per loro.

La parola moderna consente le differenze di versione, le annotazioni con il monitoraggio della versione e la fusione delle modifiche. Potrebbe non essere semplice come il codice di unione, ma ho visto molti project manager farlo facilmente, quindi sicuramente anche gli sviluppatori possono riuscire a farlo.

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

    
risposta data 17.07.2013 - 17:30
fonte
4

Personalmente penso che sia un problema di educazione.

La maggior parte delle persone è stata indotta a pensare che l'uso di uno strumento come MS Word faciliti la produzione di documenti di qualità, ma da quello che ho visto rende effettivamente più difficile. Si finisce per dover eseguire il debug della formattazione all'infinito e combattere gli strumenti per ottenere il risultato desiderato.

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

Nella mia organizzazione più persone con cui passo a utilizzare MarkDown per la maggior parte del loro documento richiedono più persone sono più felici e più produttive.

    
risposta data 23.07.2013 - 22:46
fonte
0

Hai davvero 2 domande:

Primo: Perché i gruppi non di sviluppo non utilizzano 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 dover imparare un altro metodo per fare la stessa cosa che stanno facendo. Loro sanno poco su come diff 2 documenti e quindi non ha molto valore nel cambiare in un formato basato su testo per loro. Spiegare a una persona che hai una soluzione per un problema che non sapevano di avere è una vendita piuttosto dura.

Inoltre, non puoi sottovalutare il valore del momento in avanti. Per migrare verso un nuovo formato devi davvero convincere altre persone della tua catena che vale la pena investire per imparare qualcosa di nuovo. Anche se non ti aspetti che possano modificare qualcosa, ci vuole tempo e molto impegno per migrare a un nuovo formato quando un formato esistente funziona (anche se male).

La seconda domanda: perché il mio team continua a utilizzare i documenti di parole quando ci sono opzioni migliori e sono più che capaci di apprenderli?

Questo è qualcosa su cui dovresti parlare con le persone della tua squadra. Ci possono essere validi motivi per cui scelgono di conservare documenti di parole o potrebbe essere semplicemente perché è sempre stato così.

Ci sono dei costi associati a qualsiasi cambiamento e può essere costoso e dispendioso in termini di tempo per spostare centinaia o migliaia di documenti in un nuovo formato. Se hai intenzione di provare a cambiare il tuo ambiente, aspettati di dover spiegare il motivo per cui dovresti cambiare

    
risposta data 02.12.2014 - 21:13
fonte

Leggi altre domande sui tag