Jakie przeszkody stoją w obliczu procesu opracowywania przy użyciu zwykłych języków znaczników w przeciwieństwie do np. Microsoft Word? [Zamknięte]

Obecnie jestem stażystą u kontrahenta rządowego i mam (obrzydliwie nieuniknione) wrażenie, że Word jest de facto standardem w procesie tworzenia oprogramowania.

Jego format binarny bardzo utrudnia współpracę nad dokumentami w sposób, w jaki jestem przyzwyczajony do współpracy na bazie kodu. Użycie znaczników zwykłego tekstu (w takich językach, jak LaTeX, Markdown, ReStructured Text itp. ) Pozwala na utworzenie dokumentu przyjaznego dla różnic, który działa dobrze przy normalnym przepływie pracy programisty. Jeśli chodzi o komentarze, w których język ich nie obsługuje (np. Markdown), istnieje wiele istniejących rozwiązań, które umożliwiają wspólne komentowanie baz kodu (np. GitHub, Bitbucket), które można łatwo zastosować do innych plików tekstowych zawierających znaczniki.

Rozumiem, że potrzeba współpracy z niepiśmiennym technologicznie zarządzaniem wymaga pewnego rodzaju interfejsu graficznego do wszystkiego, ale takie interfejsy istnieją dla większości tych formatów. Na przykład LaTeX ma swego rodzaju „rozwidlenie” o nazwie LyX, które nadaje graficzny interfejs frontonowi tekstowemu składni podobnej do LaTeX-a. Ten plik, choć przede wszystkim graficzny w edycji, jest nadal przyjazny dla diff. (Ma nawet komentarze w stylu Worda). Wiele z tych rozwiązań można jeszcze zastosować zamiast Worda, a zdecydowana większość jest darmowa lub open source.

Używamy jednak programu Word nawet do naszej wewnętrznej dokumentacji, której nikt inny nie widzi. Pracujemy z tekstem przez znaczną część naszej kariery - dlaczego dokumentacja jest tak wyjątkowa? Oprócz banalnego „Nie wiedzieliśmy nic lepszego, a teraz utknęliśmy tutaj”, muszą istnieć powody przemawiające za taką decyzją. Jakie wyzwania stoją przed procesem tworzenia oprogramowania w zakresie korzystania z dokumentacji tekstowej zamiast innych, bardziej potocznych (i zdecydowanie mniej wydajnych) sposobów pisania dokumentów?

Ponieważ powody będą się różnić, być może należy osobno udzielić odpowiedzi na te dwa ściśle powiązane scenariusze.

• Korzystanie z dokumentacji tekstowej od samego początku
• Z czasem migracja do dokumentacji w postaci zwykłego tekstu

Wielu uczestników procesu opracowywania oprogramowania nie jest programistami i potrzebuje możliwości interakcji z dokumentacją niezależnie. Czy QA / Marketing powinien używać słowa, a programiści powinni używać czegoś zupełnie innego? Byłoby to niespójne, dodałoby kolejne narzędzie do łańcucha konserwacji, a dział informatyczny firmy może nie mieć pojęcia, co zrobić z plikami, gdy doskonale wiedzą, jak zarządzać magazynem dokumentów Word.

Przede wszystkim wielu nie-programistów spędzało lata na uniwersytecie, używając Microsoft Word do zmiany swojej pracy, często odbywając rzeczywiste szkolenia z zakresu używania słowa. Znają to znacznie lepiej niż alternatywy. Z trudem potrafię odróżnić różnicę, kiedy pracuję w Open Office vs. Word, ale kiedy moja szwagierka wykorzystała je, by zaoszczędzić pieniądze, tydzień później kazała swojemu mężowi kupić Słowo i ogłosiła: „Odkąd mam słowo, kocham mój nowy laptop! ”. Pomyśl o sposobie myślenia, który łączy takie rzeczy, niewielka zmiana tego, do czego są przyzwyczajeni, nie jest dla nich „niewielka”.

Nowoczesne słowo umożliwia także różnicę wersji, adnotacje ze śledzeniem wersji oraz scalanie zmian. Może to nie być tak proste, jak scalanie kodu, ale widziałem, jak wielu kierowników projektów robi to z łatwością, więc z pewnością deweloperzy też mogą to zrobić.

Poza tym zespoły deweloperów dość często zajmują się tworzeniem dokumentacji na stronach wiki, ponieważ wraca do reprezentacji tekstowej, pozostając na tyle prostym, że osoby, które nie są programistami, mogą edytować.

Osobiście uważam, że to kwestia edukacji.

Większość ludzi została oszukana, by pomyśleć, że użycie narzędzia takiego jak MS Word ułatwia tworzenie wysokiej jakości dokumentów, ale z tego, co widziałem, w rzeczywistości utrudnia. W końcu musisz bez końca debugować formatowanie i walczyć ze swoimi narzędziami, aby uzyskać pożądany rezultat.

Narzędzia takie jak Scrivener pozwalają zbliżyć się do rzeczywistości dokumentu bez konieczności walki z nim tak, jak w przypadku programu Word. Częściowo z powodu realizacji WYSIWYG w rzeczywistości nie działa zbyt dobrze.

W mojej organizacji, im więcej osób używam MarkDown do większości potrzeb związanych z dokumentami, tym więcej ludzi jest szczęśliwszych i bardziej produktywnych.

Naprawdę masz 2 pytania:

Po pierwsze: dlaczego grupy inne niż deweloperów nie używają LaTeXa lub innego Markdown w procesie tworzenia oprogramowania?

Problem z migracją do LaTeX polega na postrzeganej krzywej uczenia się, szczególnie w przypadku użytkowników nietechnicznych. Użytkownicy znają już inne formaty i nie chcą się uczyć innej metody robienia tego samego, co robią. Wiedzą niewiele, jeśli w ogóle, na temat różnicowania 2 dokumentów, więc przejście na format tekstowy jest niewielkie. Wyjaśnienie osobie, że masz rozwiązanie problemu, o którym nie wiedzieli, że jest, to dość trudna sprzedaż.

Nie można również nie docenić wartości pędu do przodu. Aby przejść do nowego formatu, naprawdę musisz przekonać inne osoby w łańcuchu, warto zainwestować w naukę czegoś nowego. Nawet jeśli nie spodziewasz się, że coś zmodyfikują. Migracja do nowego formatu wymaga czasu i dużego wysiłku, jeśli istniejący format działa (nawet jeśli źle).

Drugie pytanie: dlaczego mój zespół nadal korzysta z dokumentów słownych, gdy istnieją lepsze opcje i są w stanie się ich nauczyć?

Jest to coś, o czym powinieneś porozmawiać z ludźmi w swoim zespole. Mogą istnieć ważne powody, dla których decydują się na zachowanie dokumentów słownych, lub może tak być, ponieważ zawsze tak było.

Każda zmiana wiąże się z kosztami i przeniesienie setek lub tysięcy dokumentów do nowego formatu może być kosztowne i czasochłonne. Jeśli zamierzasz zmienić swoje środowisko, spodziewaj się, że powinieneś to zrobić