Quels sont les obstacles auxquels se heurte le processus de développement en utilisant des langages de balisage en texte brut, par exemple, Microsoft Word? [fermé]


33

Je suis actuellement stagiaire chez un contractant gouvernemental et je ressens (ce qui est odieusement inévitable) que Word est la norme de facto dans le processus de développement de logiciels.

Son format binaire rend très difficile la collaboration sur des documents comme je suis habitué à collaborer sur une base de code. L'utilisation de balises de texte brut (avec des langages tels que LaTeX, Markdown, ReStructured Text, etc. ) permet de créer un document facile à utiliser pour les différences qui fonctionne bien avec le flux de travail normal d'un développeur. En ce qui concerne les commentaires dont le langage ne les prend pas en charge (par exemple, Markdown), il existe de nombreuses solutions permettant des commentaires collaboratifs sur des bases de code (par exemple, GitHub, Bitbucket) qui pourraient facilement être appliquées à d'autres fichiers en texte brut contenant des balises.

Je comprends que la nécessité de coopérer avec la gestion des illettrés technologiquement nécessite une sorte d’interface graphique pour tout, mais de telles interfaces existent pour la plupart de ces formats. Par exemple, LaTeX a une sorte de fourche appelée LyX qui met une interface graphique à une syntaxe en texte brut, semblable à LaTeX. Ce fichier, même s'il est principalement graphique dans son édition, est toujours facile à utiliser. (Il contient même des commentaires de style Word.) Bon nombre de ces solutions pourraient encore être utilisées à la place de Word, et la grande majorité d'entre elles sont gratuites ou à code source ouvert.

Cependant, nous utilisons Word même pour notre propre documentation interne que personne d'autre ne voit. Nous travaillons avec du texte pendant une bonne partie de notre carrière. Pourquoi la documentation est-elle si spéciale? En plus du trivial "Nous ne savions pas mieux et maintenant nous sommes coincés ici", il doit y avoir des raisons pour appuyer une telle décision. Quels sont les défis auxquels le processus de développement logiciel est confronté en utilisant une documentation en texte brut au lieu d’autres moyens plus classiques (et moins puissants au point de parler) d’écrire des documents?

Puisque les raisons diffèrent, il convient peut-être de répondre séparément à ces deux scénarios étroitement liés.

  • Utiliser la documentation en texte brut depuis le début
  • Migration vers la documentation en texte brut au fil du temps

2
pour des raisons indépendantes, il peut être judicieux de migrer vers des versions plus récentes de word (office 2007 / 12.0 et versions ultérieures) dont les formats de document sont basés sur xml. des versions à jour d'openoffice et en particulier de libreoffice pourraient s'avérer un choix encore plus judicieux. Les filtres d'importation / exportation permettent une intégration transparente avec un flux de travail basé sur MS Word. plus concrètement, travailler avec des langages de balisage dans la mise en page demande un niveau d'abstraction plus élevé et une meilleure structuration des idées à l'avance, tout en ne facilitant pas facilement l'écriture exploratoire. et bien sûr, l'interface utilisateur est habituelle - aucune formation requise.
Collapsar

2
Je ne suis pas sûr d’être d’accord avec votre prémisse - je suis sûr qu’il existe de nombreux endroits où l’un ou l’autre des langages de balisage, en raison des avantages que vous décrivez.
vaughandroid

1
Comme l'a souligné collapsar, il est très facile de programmer des documents Word basés sur XML (sdk openxml, ... (je peux conseiller les sites ClosedXML et Novasoft.DocX ​​pour c #). En venant d'un milieu universitaire, TEX peut sembler génial, mais si ce n'est pas le cas, La courbe d'apprentissage est bien trop longue! Votre mère et votre grand-mère savent probablement de quoi on parle. Interrogez-les à propos de TEX, je serais surprise!
Mvision

1
Et dans la mesure où l'interface utilisateur est intuitive, cela est vrai pour une bonne partie du flux de travail d'un niveau de cliché normal, mais se décompose pour tout ce qui est plus complexe. Voir superuser.com/questions/620454 et notez également que le moyen de mettre à jour une table des matières consiste à en insérer une nouvelle au milieu et à attendre le menu contextuel. Pour ignorer l'orthographe d'un morceau de texte de façon persistante, vous devez définir la langue <-null. Est-ce que cela est intuitif? Mais c'est d'ailleurs le point. Le texte brut expose complètement la structure et le contenu du document; pas de gâchis, pas de chichi.
Sean Allred

1
@rath Absolutely. Si quelqu'un espère attirer de jeunes esprits du côté obscur, les commentaires / réponses aux liens devraient vous aider à démarrer. (Surtout la présentation de Jubobs - il a mis en ligne une archive de son contenu et il est très bon.)
Sean Allred

Réponses:


43

De nombreux participants au processus de développement de logiciels ne sont pas des développeurs et ont besoin de pouvoir interagir avec la documentation, peu importe. L’Assurance Qualité / Marketing doit-elle utiliser Word et les développeurs doivent-ils utiliser quelque chose d’autre? Ce serait incohérent, cela ajouterait un autre outil dans la chaîne de maintenance et le service informatique d'une entreprise n'aurait peut-être aucune idée de ce qu'il faudrait faire avec les fichiers, alors qu'il sait parfaitement bien gérer / maintenir un magasin de documents Word.

Avant tout, de nombreux non-développeurs ont passé des années à l’université à utiliser Microsoft Word pour effectuer leur travail, après avoir souvent suivi des cours de formation sur l’utilisation de Word. Ils le savent bien mieux que les alternatives. Je peux difficilement faire la différence lorsque je travaille dans Open Office vs Word, mais lorsque ma belle-sœur l’utilisa pour économiser de l’argent, une semaine plus tard, elle demanda à son mari d’acheter Word et de proclamer: «Depuis que j’ai eu la parole, j’aime. mon nouvel ordinateur portable! ". Pensez à la mentalité qui confond les choses de ce genre, un léger changement dans ce à quoi ils sont habitués ne leur est pas "légère".

Le mot moderne autorise les différences de version, les annotations avec suivi de version et la fusion des modifications. Ce n'est peut-être pas aussi simple que de fusionner du code, mais j'ai vu de nombreux gestionnaires de projets le faire facilement, alors les développeurs peuvent certainement le faire aussi.

Au-delà de cela, il est devenu assez courant parmi les équipes de développement de créer de la documentation dans les wikis, car elle revient à la représentation textuelle tout en restant assez simple pour que les non-développeurs puissent effectuer des modifications.


7
Je ne suis pas d' accord en partie avec votre deuxième paragraphe: La plupart des gens avec lesquels je travaille ont aucune idée que ce soit sur la façon d'utiliser Word et d'autres choses. Et se sentir généralement mal à l'aise avec tout ce qui ne ressemble pas à quelque chose qu'ils connaissent (des rubans n'importe qui? ;-)). Cela signifie que l'on peut leur imposer n'importe quoi. Le reste le résume assez bien malheureusement.
nietonfir

@nietonfir wow, j'ai appris que ce mot est chaque outil préféré des personnes du PM et de la QA (lire: uniquement)
Jimmy Hoffa le

4
@ JimmyHoffa C'est le cas, mais la plupart ne savent pas utiliser correctement Word (index, sous-titres d'image, en-têtes de première page, numérotation, titres,…).
nietonfir

2
@ JimmyHoffa: Oui, mais combien d'entraînement ont-ils reçu pour cela? Et combien de fonctions de Word utilisent-ils vraiment? IMHO la plupart de ces utilisateurs pourraient facilement basculer vers WordPad.
Réintégrer Monica - M. Schröder le

Oh, bonjour, @ MartinSchröder :-) En ce qui concerne WordPad, même si la plupart des rédacteurs de contenu ne savent peut-être pas comment utiliser MS Word au maximum de son potentiel, quelques-uns le savent . D'après mon expérience, il s'agit d'un petit groupe d'utilisateurs expérimentés qui configurent un document (encore et encore) pour les utilisateurs qui ajoutent la majeure partie du contenu. Quand quelqu'un veut ajouter un chiffre, un commentaire est ajouté. (La maintenance du document en tant que document devient alors au moins un travail à temps partiel.)
Sean Allred le

4

Personnellement, je pense que c'est une question d'éducation.

La plupart des gens ont été amenés à croire que l'utilisation d'un outil tel que MS Word facilite la production de documents de qualité, mais rend la tâche encore plus difficile. Vous finissez par avoir à déboguer le formatage à l'infini et à vous battre contre vos outils pour obtenir le résultat souhaité.

Des outils tels que Scrivener vous permettent de vous rapprocher un peu de la réalité du document sans devoir vous battre comme vous le faites avec Word. En partie à cause de la réalisation, le WYSIWYG ne fonctionne pas très bien.

Dans ma propre entreprise, plus de personnes utilisent MarkDown pour la plupart de leurs besoins en documents, plus elles sont heureuses et productives.


Êtes-vous en train de suggérer qu'il est plus facile de "déboguer" LaTeX que MS Word?
user253751

@immibis LaTeX3 sait que c'est un problème (même LaTeX2e, mais il n'a pas réussi à faire passer le message). Idéalement, aucun codage n'est effectué au niveau du document (exposé à l'auteur). Tout le «débogage» est effectué au niveau du code, où des personnes familières avec la langue effectuent ce travail. Croyez-moi, expl3les messages d'erreur sont beaucoup plus utiles :)
Sean Allred

@immibis Il est en fait plus facile de "déboguer" LaTeX que MSWord. Il existe des problèmes de formatage dans MSWord qui ne peuvent être résolus par personne sans modifier le programme MSWord lui-même. Dans ces cas, vous pouvez prendre tout le temps dont vous avez besoin pour apprendre LaTeX -> TeX -> C -> Assembler, quelle que soit la profondeur dont vous avez besoin. Je connais des utilisateurs extérieurs au domaine du développement logiciel qui ont une bonne connaissance pratique de LaTeX et de choses comme pstricks. Ils choisissent LaTex sur Word à chaque fois. Ils usu. ne faites pas beaucoup de débogage complexe, ils demandent simplement à quelqu'un de l’aider, ce qui pour eux arrive moins souvent que sous MSWord.
Wolfmanx

0

Vous avez vraiment 2 questions:

Premièrement: Pourquoi les groupes autres que de développement n'utilisent-ils pas LaTeX ou un autre Markdown dans le processus de développement logiciel?

Le problème de la migration vers LaTeX est la courbe d’apprentissage perçue, en particulier lorsque vous avez affaire à des utilisateurs non techniques. Les utilisateurs connaissent déjà d'autres formats et ne veulent pas apprendre une autre méthode pour faire la même chose. Ils savent peu ou pas du tout sur la façon de différencier 2 documents et il est donc peu utile de passer à un format texte pour eux. Expliquer à une personne que vous avez une solution à un problème qu'elle ne savait pas avoir est une vente difficile.

Vous ne pouvez pas non plus sous-estimer la valeur d'un élan vers l'avant. Pour migrer vers un nouveau format, vous devez vraiment convaincre les autres membres de votre chaîne que cela vaut la peine d'investir pour apprendre quelque chose de nouveau. Même si vous ne vous attendez pas à ce qu'ils modifient quoi que ce soit Il faut du temps et beaucoup d'efforts pour migrer vers un nouveau format lorsqu'un format existant fonctionne (même s'il est médiocre).

La deuxième question: pourquoi mon équipe continue-t-elle à utiliser des documents Word alors qu’il existe de meilleures options et qu’ils sont plus que capables de les apprendre?

C’est quelque chose dont vous devriez parler avec les membres de votre équipe. Il peut y avoir des raisons valables pour lesquelles ils choisissent de conserver des documents au format Word ou tout simplement parce que c'est ainsi que cela a toujours été fait.

Tout changement entraîne des coûts et il peut être coûteux en temps et en argent de déplacer des centaines ou des milliers de documents vers un nouveau format. Si vous voulez modifier votre environnement, attendez-vous à justifier pourquoi vous devriez changer


1
cela n'essaye même pas de répondre à la question: "Pourquoi les langages de balisage en texte brut (comme LaTeX ou Markdown) ne sont-ils pas plus populaires dans le processus de développement logiciel?"
Gnat

+0, mais d'accord - ce serait plus approprié comme commentaire.
Sean Allred

1
Après la première édition de la question, la situation est devenue bien meilleure. @gnat, un autre regard est en ordre.
Sean Allred
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.