Quais obstáculos enfrentam o processo de desenvolvimento no uso de linguagens de marcação de texto sem formatação, em oposição a, por exemplo, Microsoft Word? [fechadas]

33

Atualmente, sou estagiário em uma empresa contratada pelo governo e estou tendo a sensação (irritantemente inevitável) de que o Word é o padrão de fato no processo de desenvolvimento de software.

Seu formato binário dificulta muito a colaboração em documentos da maneira como estou acostumado a colaborar em uma base de código. O uso da marcação de texto sem formatação (com idiomas como LaTeX, Markdown, ReStructured Text, etc. ) permite um documento de fácil compreensão que funciona bem com o fluxo de trabalho normal de um desenvolvedor. Quanto aos comentários em que o idioma não os suporta (por exemplo, Markdown), existem muitas soluções existentes que permitem comentários colaborativos em bases de código (por exemplo, GitHub, Bitbucket) que podem ser facilmente aplicadas a outros arquivos de texto sem formatação que contenham marcação.

Entendo que a necessidade de cooperar com o gerenciamento tecnologicamente analfabeto exige algum tipo de interface gráfica para tudo, mas essas interfaces existem para a maioria desses formatos. Por exemplo, o LaTeX possui um tipo de "garfo" chamado LyX que coloca um front-end gráfico em uma sintaxe de texto simples, semelhante ao LaTeX. Este arquivo, embora principalmente gráfico em sua edição, ainda é fácil de usar. (Ele também possui comentários no estilo do Word.) Muitas dessas soluções ainda podem ser usadas no lugar do Word, e a grande maioria é gratuita ou de código aberto.

No entanto, usamos o Word mesmo para nossa própria documentação interna que ninguém mais vê. Trabalhamos com texto para uma parte significativa da nossa carreira - por que a documentação é tão especial? Além do trivial "Não sabíamos melhor e agora estamos presos aqui", deve haver razões para apoiar essa decisão. Quais são os desafios enfrentados pelo processo de desenvolvimento de software no uso da documentação em texto simples em vez de outros meios mais coloquiais (e debativelmente menos poderosos) de escrever documentos?

Como os motivos serão diferentes, talvez seja necessário responder a esses dois cenários intimamente relacionados separadamente.

  • Usando documentação em texto sem formatação desde o início
  • Migrando para documentação em texto sem formatação ao longo do tempo
Sean Allred
fonte
2
por motivos independentes, pode ser aconselhável migrar para versões mais recentes do word (office 2007 / 12.0 e superior) cujos formatos de documento são baseados em xml. versões atualizadas do openoffice e especialmente do libreoffice podem ser uma opção ainda melhor - os filtros de importação / exportação permitem uma integração perfeita com um fluxo de trabalho baseado em palavras do ms. mais ao ponto, trabalhar com linguagens de marcação na configuração de páginas exige um nível mais alto de abstração e melhor estruturação de idéias, sem oferecer suporte à escrita exploratória. e, é claro, a interface do usuário do ms office é habitual - não é necessário treinamento.
Colapsar 17/07/2013
2
Não sei se concordo com sua premissa - tenho certeza de que há muitos lugares em uma ou outra linguagem de marcação, devido aos benefícios que você descreve.
vaughandroid
1
Como o collapsar apontou, os documentos de palavras baseados em XML são muito fáceis de programar para (openxml sdk, ... (posso aconselhar o ClosedXML e Novasoft.DocX ​​para c #). Quando provenientes de uma formação acadêmica, o TEX pode parecer ótimo, mas se não .!. um usa-lo, é tão bom como morto A curva de aprendizagem é muito alto sua mãe e sua avó provavelmente sabe o que a palavra é Pergunte-lhes sobre TEX, eu ficaria surpreso!
Mvision
1
E, na medida em que a interface do usuário é intuitiva, isso é verdade para uma boa parte do fluxo de trabalho normal do nível de clichê, mas se decompõe para algo mais complexo. Consulte superuser.com/questions/620454 e observe também que a maneira de atualizar um sumário é inserir um novo no meio e aguardar o pop-up. A maneira de ignorar persistentemente a ortografia para um pedaço de texto é definir o idioma <-null. Isso é intuitivo? Mas isso está além do ponto. O texto sem formatação expõe completamente a estrutura e o conteúdo do documento; sem bagunça, sem barulho.
Sean Allred
1
@rath Absolutamente. Se alguém espera trazer algumas mentes jovens para o lado sombrio, os comentários / respostas aos links devem ajudar você a começar. (Apresentação Especialmente Jubobs' --- ele carregou um arquivo de ele e ele é muito bom.)
Sean Allred

Respostas:

43

Muitos participantes no processo de desenvolvimento de software não são desenvolvedores e precisam da capacidade de interagir com a documentação independentemente. O controle de qualidade / marketing deve usar o word e os desenvolvedores usam algo completamente diferente? Seria inconsistente, acrescentaria outra ferramenta à cadeia de manutenção e a parte de TI de uma empresa pode não ter idéia do que fazer com os arquivos, quando souberem perfeitamente como gerenciar / manter um repositório de documentos do Word.

Acima de tudo, muitos não desenvolvedores passaram anos na universidade usando o Microsoft Word para entregar seus trabalhos, frequentemente tendo tido aulas de treinamento reais sobre como usar o word. Eles sabem disso muito melhor do que alternativas. Eu mal posso dizer a diferença quando estou trabalhando no Open Office vs Word, mas quando minha cunhada a usou para economizar dinheiro, uma semana depois, ela pediu ao marido que comprasse a palavra e proclamou "Desde que recebi a palavra eu amo meu novo laptop! ". Pense na mentalidade que confunde coisas assim, uma ligeira mudança no que elas estão acostumadas não é 'leve' para elas.

A palavra moderna permite diferenças de versão, anotações com rastreamento de versão e mesclagem de alterações também. Pode não ser tão simples quanto a mesclagem de códigos, mas já vi muitos gerentes de projeto fazerem isso facilmente, portanto, certamente os desenvolvedores também podem fazê-lo.

Além disso, tornou-se bastante comum entre as equipes de desenvolvimento fazer documentação nas wikis, porque ela volta à representação textual enquanto permanece simples o suficiente para que não-desenvolvedores possam fazer edições.

Jimmy Hoffa
fonte
7
Em parte, não concordo com o seu segundo parágrafo: a maioria das pessoas com quem trabalho não faz idéia de como usar o Word e outras coisas. E geralmente se sente desconfortável com algo que não se parece com algo que eles conhecem (alguém sabe como usar fitas; ;-)). Isso significa que se pode impor qualquer coisa a eles. O resto resume muito bem, infelizmente.
Nietonfir
@nietonfir uau, Tem sido minha experiência que palavra é cada PM e (leia-se: apenas) QA pessoas favorito ferramenta
Jimmy Hoffa
4
@JimmyHoffa É, mas a maioria não sabe como usar o Word corretamente (por exemplo, índice, legendas de imagens, cabeçalhos da primeira página, numerações, cabeçalhos,…).
Nietonfir 19/07
2
@JimmyHoffa: Sim, mas quanto treinamento eles receberam? E quanto das funções do Word eles realmente usam? IMHO a maioria desses usuários poderia facilmente mudar para o WordPad.
Restabeleça Monica - M. Schröder
Oh oi, @ MartinSchröder :-) Quanto WordPad, enquanto a maioria dos escritores de conteúdo pode não saber como usar o MS Word para o seu 'potencial' completa, alguns deles fazem . De acordo com minha experiência, é um pequeno conjunto de usuários avançados que configuram um documento (repetidamente) para os usuários que realmente adicionam a maior parte do conteúdo. Quando alguém deseja adicionar uma figura, um comentário é adicionado. (Manutenção do documento como um documento , então, torna-se, pelo menos, um emprego a tempo parcial.)
Sean Allred
4

Pessoalmente, acho que é uma questão de educação.

A maioria das pessoas foi levada a pensar que o uso de uma ferramenta como o MS Word facilita a produção de documentos de qualidade, mas, pelo que vi, na verdade, fica mais difícil. Você acaba depurando a formatação sem parar e luta com suas ferramentas para obter o resultado desejado.

Ferramentas como o Scrivener permitem que você se aproxime um pouco da realidade do documento sem precisar lutar contra isso como você faz com o Word. Em parte devido à realização do WYSIWYG, na verdade, não funciona muito bem.

Na minha própria organização, quanto mais pessoas passarem a usar o MarkDown para a maioria dos documentos, mais pessoas serão mais felizes e produtivas.

aboy021
fonte
Você está realmente sugerindo que é mais fácil "depurar" o LaTeX do que o MS Word?
precisa saber é o seguinte
@immibis O LaTeX3 sabe que isso é um problema (até o LaTeX2e, mas não conseguiu entender). Idealmente, não há codificação feita no nível do documento (exposto ao autor). Toda a 'depuração' é feita no nível do código, onde você tem pessoas familiarizadas com o idioma. Confie em mim, as expl3mensagens de erro são muito mais úteis :)
Sean Allred
@immibis Na verdade, é mais fácil "depurar" o LaTeX do que o MSWord. Existem peculiaridades de formatação no MSWord que não podem ser corrigidas por ninguém sem modificar o próprio programa MSWord. Nesses casos, você pode dedicar todo o tempo necessário para aprender o LaTeX -> TeX -> C -> Assembler, por mais profundo que seja. Conheço usuários fora do campo de desenvolvimento de software que possuem um bom conhecimento de trabalho sobre o LaTeX e coisas como pstricks. Eles escolhem o LaTex sobre o Word todas as vezes. Eles usu. não faça muita depuração complexa, eles apenas pedem ajuda a alguém, o que para eles acontece com menos frequência do que com o MSWord.
Lobomanx
0

Você realmente tem 2 perguntas:

Primeiro: Por que grupos que não são de desenvolvimento não usam LaTeX ou outro Markdown no processo de desenvolvimento de software?

O problema da migração para o LaTeX é a curva de aprendizado percebida, principalmente quando você lida com usuários não técnicos. Os usuários já conhecem outros formatos e não querem aprender outro método para fazer a mesma coisa que estão fazendo. Eles sabem pouco ou nada sobre como diferenciar 2 documentos e, portanto, há pouco valor em mudar para um formato baseado em texto para eles. Explicar a uma pessoa que você tem uma solução para um problema que ela não sabia que tinha é uma venda bastante difícil.

Você também não pode subestimar o valor do impulso para a frente. Para migrar para um novo formato, você realmente precisa convencer outras pessoas da sua cadeia, vale a pena investir em aprender algo novo. Mesmo que você não espere que eles editem nada, leva tempo e muito esforço para migrar para um novo formato quando um formato existente funciona (mesmo que seja ruim).

A segunda pergunta: Por que minha equipe continua a usar documentos do Word quando existem melhores opções e são mais capazes de aprendê-los?

É algo sobre o qual você deve conversar com as pessoas da sua equipe. Pode haver razões válidas para que eles optem por manter documentos do Word ou apenas porque é assim que sempre foi feito.

Existem custos associados a qualquer alteração e pode ser caro e demorado mover centenas ou milhares de documentos para um novo formato. Se você vai tentar mudar seu ambiente, espere ter que argumentar por que você deve mudar

stoj
fonte
1
isso nem tenta responder à pergunta: "Por que as linguagens de marcação de texto sem formatação (como LaTeX ou Markdown) são mais populares no processo de desenvolvimento de software?"
Gd2
+0, mas concordou - isso seria mais apropriado como um comentário.
Sean Allred
1
Após a primeira edição da pergunta, ela se tornou muito melhor. @gnat, outro olhar está em ordem.
Sean Allred