Welche Hindernisse stehen dem Entwicklungsprozess bei der Verwendung von Markup-Sprachen im Klartext gegenüber, im Gegensatz zu z. B. Microsoft Word? [geschlossen]

Ich bin derzeit Praktikant bei einem staatlichen Auftragnehmer und habe das (widerwärtig unvermeidliche) Gefühl, dass Word der De-facto-Standard im Softwareentwicklungsprozess ist.

Das Binärformat macht es sehr schwierig, an Dokumenten so zusammenzuarbeiten, wie ich es von einer Codebasis gewohnt bin. Die Verwendung von Nur-Text-Markups (mit Sprachen wie LaTeX, Markdown, ReStructured Text usw. ) ermöglicht ein diff-freundliches Dokument, das gut mit dem normalen Workflow eines Entwicklers zusammenarbeitet. Bei Kommentaren, die von der Sprache nicht unterstützt werden (z. B. Markdown), gibt es viele vorhandene Lösungen, die kollaborative Kommentare zu Codebasen (z. B. GitHub, Bitbucket) ermöglichen, die problemlos auf andere Nur-Text-Dateien angewendet werden können, die Markups enthalten.

Ich verstehe, dass die Notwendigkeit, mit dem Management von technologisch unerfahrenen Personen zusammenzuarbeiten, eine Art grafische Schnittstelle zu allem erfordert, aber für die meisten dieser Formate gibt es solche Schnittstellen. In LaTeX gibt es beispielsweise eine Art Fork namens LyX, mit dem ein grafisches Front-End für eine LaTeX-ähnliche Klartext-Syntax erstellt wird. Diese Datei ist, obwohl hauptsächlich grafisch bearbeitet, immer noch diff-freundlich. (Es enthält sogar Kommentare im Word-Stil.) Viele dieser Lösungen könnten noch anstelle von Word verwendet werden, und die überwiegende Mehrheit ist kostenlos oder Open Source.

Wir verwenden Word jedoch auch für unsere eigene interne Dokumentation, die sonst niemand sieht. Wir arbeiten mit Texten für einen bedeutenden Teil unserer Karriere - warum ist Dokumentation so besonders? Abgesehen von der Kleinigkeit "Wir haben es nicht besser gewusst und jetzt stecken wir hier fest", muss es Gründe geben, die eine solche Entscheidung stützen. Welchen Herausforderungen steht der Softwareentwicklungsprozess gegenüber, wenn die Verwendung von Klartextdokumentation anstelle anderer, umgangssprachlicherer (und umstritten weniger leistungsfähiger) Mittel zum Schreiben von Dokumenten verwendet wird?

Da sich die Gründe unterscheiden, sollte die Beantwortung dieser beiden eng verwandten Szenarien möglicherweise getrennt erfolgen.

• Von Anfang an Klartextdokumentation verwenden
• Migration auf Nur-Text-Dokumentation im Laufe der Zeit

Viele Teilnehmer am Softwareentwicklungsprozess sind keine Entwickler und benötigen die Fähigkeit, mit der Dokumentation zu interagieren. Sollte QA / Marketing Word verwenden und Entwickler etwas ganz anderes verwenden? Es wäre inkonsistent, würde ein weiteres Tool in die Wartungskette aufgenommen, und der IT-Teil eines Unternehmens hätte möglicherweise keine Ahnung, was mit den Dateien zu tun ist, wenn er sich mit der Verwaltung / Pflege eines Word-Dokumentenspeichers bestens auskennt.

Vor allem haben viele Nicht-Entwickler jahrelang an der Universität mit Microsoft Word gearbeitet, um ihre Arbeit zu erledigen. Häufig hatten sie Schulungen zum Umgang mit Word. Sie wissen es viel besser als Alternativen. Ich kann kaum einen Unterschied feststellen, wenn ich in Open Office oder Word arbeite, aber als ich meine Schwägerin damit Geld sparen ließ, ließ sie eine Woche später ihren Ehemann ihr Word kaufen und verkündete: "Seit ich ein Wort habe, das ich liebe mein neuer Laptop! " Denken Sie an die Denkweise, die solche Dinge zusammenbringt. Eine geringfügige Änderung in dem, was sie gewohnt sind, ist für sie nicht geringfügig.

Moderne Wörter erlauben auch Versionsunterschiede, Anmerkungen mit Versionsverfolgung und das Zusammenführen von Änderungen. Es ist vielleicht nicht so einfach wie das Zusammenführen von Code, aber ich habe viele Projektmanager gesehen, die es einfach machen, also können Entwickler es mit Sicherheit auch schaffen.

Darüber hinaus ist es unter Entwicklerteams durchaus üblich geworden, Dokumentation in Wikis zu erstellen, da die Textdarstellung wiederhergestellt wird und gleichzeitig so einfach bleibt, dass auch Nichtentwickler Änderungen vornehmen können.

Persönlich denke ich, dass es um Bildung geht.

Die meisten Menschen haben den Eindruck gewonnen, dass die Verwendung eines Tools wie MS Word die Erstellung von qualitativ hochwertigen Dokumenten erleichtert, aber was ich gesehen habe, macht es tatsächlich schwieriger. Am Ende müssen Sie die Formatierung endlos debuggen und mit Ihren Tools kämpfen, um das gewünschte Ergebnis zu erzielen.

Mit Tools wie Scrivener können Sie sich ein Stück näher an die Realität des Dokuments heranwagen, ohne wie mit Word dagegen ankämpfen zu müssen. Teilweise aufgrund der Erkenntnis funktioniert das WYSIWYG nicht wirklich gut.

In meiner eigenen Organisation sind die Mitarbeiter umso zufriedener und produktiver, je mehr Mitarbeiter MarkDown für den Großteil ihrer Dokumentanforderungen einsetzen.

Du hast wirklich 2 Fragen:

Erstens: Warum verwenden Nicht-Entwicklungsgruppen im Softwareentwicklungsprozess kein LaTeX oder anderes Markdown?

Das Problem bei der Migration auf LaTeX ist die wahrgenommene Lernkurve, insbesondere wenn Sie mit nicht technischen Benutzern arbeiten. Benutzer kennen bereits andere Formate und möchten keine andere Methode erlernen, um dasselbe zu tun, was sie getan haben. Sie wissen wenig oder gar nichts darüber, wie man 2 Dokumente unterscheidet. Daher ist es wenig sinnvoll, für sie ein textbasiertes Format zu wählen. Einer Person zu erklären, dass Sie eine Lösung für ein Problem haben, von dem sie nicht wusste, dass es eine ist, ist ein ziemlich schwerer Verkauf.

Sie können auch den Wert des Vorwärtsimpulses nicht unterschätzen. Um auf ein neues Format zu migrieren, müssen Sie andere Personen in Ihrer Kette wirklich überzeugen, dass es sich lohnt, in das Erlernen neuer Funktionen zu investieren. Auch wenn Sie nicht davon ausgehen, dass sie etwas bearbeiten. Die Migration auf ein neues Format erfordert Zeit und viel Mühe, wenn ein vorhandenes Format funktioniert (auch wenn es schlecht ist).

Die zweite Frage: Warum verwendet mein Team weiterhin Word-Dokumente, wenn es bessere Optionen gibt und diese mehr als erlernbar sind?

Dies ist etwas, über das Sie mit den Leuten in Ihrem Team sprechen sollten. Es kann triftige Gründe dafür geben, dass Word-Dokumente gepflegt werden, oder es kann auch nur daran liegen, dass dies schon immer so war.

Jede Änderung ist mit Kosten verbunden und es kann teuer und zeitaufwendig sein, Hunderte oder Tausende von Dokumenten in ein neues Format zu verschieben. Wenn Sie versuchen werden, Ihre Umgebung zu ändern, müssen Sie begründen, warum Sie sich ändern sollten