Aplikacja (nie język znaczników) do tworzenia instrukcji obsługi [zamknięta]

Techniczne oprogramowanie wydawnicze-opinie na temat FrameMaker i jego Alternatywy

Wykonałem dokumenty spec z LaTeX i Framemaker, i zaprojektowałem przepływ pracy Framemaker, aby wspierać zespół analityków 5 produkujących dokument spec dla systemu ubezpieczeniowego. Dokument miał mieć około 2000 stron. Wiele lat temu (około 1992-1993) pracowałem również krótko jako maszynista.

Framemaker jest przeznaczony do dokumentacji technicznej i robi to Bardzo dobrze. posiada również funkcje przeznaczone do obsługi bardzo dużych dokumentów z wieloma autorami - ludzie używają tego systemu do tworzenia dokumentów z ponad 100 000 stron. Jest również bardziej dostępny niż LaTeX dla użytkowników zaznajomionych z oprogramowaniem do przetwarzania tekstu.

Najważniejsze cechy Framemaker:

• Dokumenty składające się z wielu files: You can pull together a "Książka" z wieloma podrozdziałami w Różne pliki. Dokument może również być utrzymywana pod kontrolą źródła.

• Tekstowy format MIF dla import/export: importer jest nieco wybredny (znalazłem generowanie pracy lateksu, aby było łatwiej), ale można generowanie elementów takich jak dane słowników i importować je do dokument. Plik posiada tekst kotwy (patrz niżej), dzięki czemu można tworzenie odsyłaczy, które będzie stabilny w całym imporcie. I znajdź to jako kluczową cechę dla specyfikacje, ponieważ pozwala na odsyłacze aby połączyć się bezpośrednio z wygenerowanym pozycji.

• Potężny system tagowania, indeksowania i odsyłaczy: Wszystko opiera się na tagach w Framemaker i łatwo jest szybko zastosować tagi. Oznacza to, że odsyłacze, indeksowanie, Tekst warunkowy i stosowanie stylów en-masse jest łatwe i po prostu działa . Możesz generować indeksy i TOCs na podstawie tagów, dzięki czemu posiadające wiele wyspecjalizowanych indeksów (np. lista nazw pól danych z ekranów lub słownika danych) to łatwe do zrobienia. Dokument I opisane powyżej miały 4 oddzielne indeksy.

• Stabilny: Framemaker jest przeznaczony do profesjonaliści, więc nie ma drugiego zgaduję, że tak jak to słowo. Jest również znacznie bardziej stabilny na dużych dokumenty. Każdy, kto próbował napisz dokument ponad 50-100 strony w Wordzie powinny mieć ładny uczciwy pomysł, co to oznacza.

• Scriptable: FM ma C API i tam są różne wtyczki Skryptowe (FrameScript oraz FMPython być prawdopodobnie najczęściej stosowanym) które można wykorzystać do automatyzacji zadań w FM. Framemaker 10 dodaje obsługę dla narzędzia skryptowego opartego na Javascript wywołane Extendscript , przypuszczalnie przeportowane na drugą stronę obiektu skryptowego w InDesign.

• Single-sourcing: z jednego FM dokument, który możesz sporządzić w formacie PDF, Windows Help (CHM), HTML i print dokumenty dość łatwo. Na odsyłacze rozwiązują również na hiperłącza.

• Global style controls: Możesz łatwe konfigurowanie stylów dla dokumentu i zastosuj go na całej dokument. Ułatwia również uruchamianie nagłówków i stopek z duża elastyczność w posiadaniu ich sekcje torów, wersje, rozdziały itp.

Alternatywy dla Framemaker

• LaTeX/Lout: już wskazałeś że nie chcesz znaczników lanaguage, ale TeX oraz Lout systemy są używane do dużych strukturyzowanych dokumentów i zrobić to cóż.

• Ventura Publisher: prawdopodobnie jedyna prawdziwa alternatywa dla Framemaker jeśli chcesz tego rodzaju interfejs użytkownika bez płacenia części ciała za przywilej. Ma silne poparcie dla strukturyzowanych dokumenty i dokument oparty na XML format wymiany. Obecnie jest własnością przez firmę Corel, która nadal aktywnie ją promuje.
  

  Istnieje kilka innych techniczne narzędzia wydawnicze na rynku: Quicksilver (który kiedyś był znany jako Interleaf) i ArborText. Te dwa narzędzia są potężne - kiedyś Interleaf był liderem na rynku w tej dziedzinie - ale dość drogie.

• Adobe Indesign: Chociaż Adobe reklamacja możesz zrobić duże dokumenty w programie InDesign odsyłacz krzyżowy i inne duże funkcje dokumentów wydają się być postrzegane jako brak przez FrameMaker afficionados. Jest, jednak system wprowadzania tekstu do niego nazwane InCopy , które najwyraźniej ma takie funkcjonalność i dość duże ciało osób trzecich wtyczki , z których niektóre wsparcie tagowania i innych takich udogodnień. InDesign posiada również Skryptowe API i interpreter JavaScript do wykonywania Skrypty.

  Nie używałem Indesign, więc nie mogę skomentować jak dobrze to działa w praktyce.

• DocBook: to jest naprawdę just standardowy format struktury dokumentów, ale ma duży ekosystem narzędzi do pisania i renderowanie dokumentów. Jeśli nie chcesz używać lateksu, będziesz prawdopodobnie nie chce używać Docbooka do podobne powody. Jako Vinko Vrsalović wskazuje (+1), ten link przechodzi do StackOverflow post od kogoś opisującego za pomocą DocBook w praktyce. Nigdy nie korzystałem z Docbooka i zrobiłem tyle edycji tego posta, że jest teraz w trybie Wiki, więc ktoś zaznajomiony z DocBook może chcę to rozwinąć.

• Edytor tekstu: Word ma poważne wady jako techniczne narzędzie do publikacji i nie jest polecam. OpenOffice ma nieco lepiej zorganizowany funkcjonalność dokumentacji niż słowo i może być lepszym wyborem, jeśli Polityka lub wymóg użycia .doc jako format wymiany dokumentów / align = "left" / Wordperfect jest również znacznie lepiej na documentation-in-the-large than word i nadal jest obecna na kilku pionowych rynkach takich jak biura prawne.

• Madcap Software ' s Blaze i Flare: te są nowe dzieci na bloku i żyją w mniej więcej tej samej przestrzeni co Framemaker. Firma została założona przez byłych EHELP (twórcy RoboHelp) pracownicy i jest aktywnie rozwijający się, z wieloma wydaniami rocznie. Ich w ciągu ostatnich dwóch lat oferta znacznie się powiększyła, na 2012-01-23 12: 00: 00 Wydaje się, że skupiono się na wprowadzaniu nowych produktów i w konsekwencji istnieje wiele problemów "dopasowania i wykończenia" w każdy. Autorzy zdecydowali się na odkrycie koła na wiele sposobów, powodujące mylące i często łamane implementacje. Oszczędzaj często, napotkasz nieobsługiwane wyjątki. Integracja kontroli źródła jest kruchy. Na przykład przeniesienie lub usunięcie grupy plików spowoduje jeden commit kontroli źródła dla każdego usunięcia pliku. Big PITA kiedy masz powiadomienia e-mail kontroli źródła. Witam 500 maili. Flare może importować pliki Word i Framemaker, ale import jest daleki od bezproblemowego. Spodziewaj się, że zachowasz wszystkie swoje treści ale planuj całkowicie od nowa stylizację. Flare podziela wiele skłonności Worda do robienia zbyt wiele za scen i zakładać, co użytkownik wybierze. HTML wygląda jak co Word wychodzi podczas eksportowania HTML-wiele niestandardowych tagów i atrybutów, głęboko zagnieżdżone style inline itp. Na tekst edytor jest wariantem, np. jego model kursora jest inny niż jakiekolwiek inne oprogramowanie, z którego kiedykolwiek korzystałeś.

Framemaker vs. LaTeX

Te dwa systemy są głównymi systemami używanymi do tworzenia dużych, reprezentacyjnych dokumentów systemowych i miałem dobre wyniki z obu.

• Łatwość Nauki: TeX może dać Ci absolutną kontrolę, ale w rzeczywistości osiągnięcie tego na złożonym lateksie dokument bez łamania innych przedmioty nie są trywialne, szczególnie gdzie duża liczba makro pakiety są zaangażowane. Basic LaTeX nie jest trudne do nauczenia się, ale dokonywanie zmodyfikowane wersje .sty files that nadal praca wymaga trochę majsterkowania jeśli nie jesteś naprawdę głębokim TeX haker. Można to zrobić, ale być przygotowany na spędzenie całkiem sporo czas ucieka.

  Framemaker może dać ci dobry stopień kontroli nad wyglądem dokumentu i nie jest taki trudny do nauczenia. Uzyskanie stylu domu i dostosowanie układu (co prawdopodobnie trzeba będzie zrobić) będzie łatwiej z Framemaker.

• Łatwość wprowadzania tekstu: Możesz użyć narzędzi takich jak Lyx , aby zapewnić Wordprocessor-like front end to Lateks, a te działają dobrze, jeśli chcesz pisać Duże ciała tekstu. Interfejs użytkownika podobny do DTP framemakera działa w sposób znany ludziom którzy są przyzwyczajeni do wordproessing oprogramowanie. Z tej perspektywy mało praktycznego różnica.

• Struktura dokumentu szablonowego: Framemaker pozwala na dokument struktura, którą należy zdefiniować w kategoriach znaczników lub schematu XML (Jeśli za pomocą Structured Framemaker). LaTeX ma zestaw elementów konstrukcyjnych w puszkach które są wystarczająco elastyczne, aby być przydatne. Dodawanie dodatkowych elementy konstrukcyjne (np. dane pozycji słownika) może być wykonana jako makro, ale czyniąc je auto-numerami jest nieco trudniejsze i będziesz trzeba grzebać za scen. Oba mogą to zrobić, ale to znacznie bardziej techniczne, aby to zrobić w Latexie w niczym nie trywialnym sprawy.

  Również LaTeX nie ma możliwość tworzenia szablonów struktura dokumentu w taki sposób, że Structured Framemaker robi. Można jednak osiągnąć ten typ efekt z DocBook, a następnie wygenerować do LaTeX w razie potrzeby.

• Łatwość integracji: znalazłem tworzenie generatora dla nietrywialnie złożone pliki MIF, aby być całkiem fiddly. Parser MIF jest dość pernickety W FM i nie do końca daj dobrą diagnostykę. LaTeX generuje znacznie lepsze komunikaty o błędach i jest trochę mniej wybredny.

Technical Publishing Software vs. Layout Software

Oprogramowanie do układania stron zaczęło się od Pagemaker , a innymi głównymi graczami w tej przestrzeni był jego konkurent Quark Xpess, a teraz InDesign, z którym Adobe zasadniczo próbuje zdeprecjonować i zastąpić go i Framemaker. Scribus , o którym wspomniałeś wcześniej, żyje w tej samej przestrzeni co te produkty.

Jeśli tworzysz podręcznik z mniej niż (powiedzmy) 50-100 stron, jeden z pakietów prawdopodobnie wykonałby odpowiednią pracę. Są one naprawdę przeznaczone do zadań reklamowych i publikacji o dużym układzie, takich jak czasopisma, więc ich obsługa funkcji dużych dokumentów, takich jak FrameMaker, jest dość ograniczona. Kluczową kwestią w przypadku tych produktów jest skalowalność - nie działają one dobrze na dużych dokumentach.

Tylko dla odniesienia mam rzeczywiście wpisze 200-stronicowa książka (czyjaś autobiografia) za pomocą Pagemaker. Podczas gdy drobnoziarnisty kerning i wiodąca Kontrola pomagają nieco w dopasowaniu do kopii, nadal jest to bardzo ręczny proces układania dokumentu o rozmiarze książki. W tym przypadku książka była tylko prostym tekstem bez znaczących odniesień lub struktury innej niż rozdziały. Zrobienie skomplikowanego dokumentu specyfikacji technicznej lub podręcznika tego rozmiaru z Pagemaker byłoby bardzo skrzypne i prawdopodobnie prawie niemożliwe, aby uzyskać prawo bez żadnych błędów.

Wydawnictwa techniczne a Edytor tekstu Oprogramowanie

Jest to bardziej opis kluczowych braków MS-Word dla dużych dokumentów spec. Jednak, to zilustruje niektóre z głównych funkcji wymaganych do documentation-in-the-large:

• Indeksowanie i odsyłacze: jest to prawdziwy obowiązek w słowie, a dość niestabilny. Framemaker ' s funkcje znakowania i etykiety LaTeX ' a oznacza, że możesz przypisać tag lub znana etykieta (w przewidywalnym formacie w razie potrzeby). Format tekstowy dla tagu kotwy są eksponowane w interfejs użytkownika i jest używany do łącznik. W słowie kotwice są znacznie bardziej nieprzezroczyste i nie łatwo sterowany w ten sposób. W połączeniu z niezdarnym użytkownikiem interfejs i niestabilność produkt, to sprawia, że utrzymanie te skrzypiące, a często niestabilne - często trzeba je ręcznie naprawić w górę.

• Szablony layoutów: Obsługa stylów w programie word jest dość podstawowa i numeracja wydaje się być nieco niestabilny. FrameMaker to wszystko jazda z tagi i zastosowanie style oparte na tagach. Global zmiany stylu działają tylko w Framemaker w taki sposób, że nie słowem.

• Duże dokumenty wielotematyczne: nigdy nie udało mi się tego zrobić dobrze w słowie, ale to jest klucz funkcja w Framemaker i LaTeX. Znów niestabilność słowa oznacza, że spędzasz dużo czasu sprzątam po nim. Jako dokument powiększa się, proporcja czasu spędzonego na tym praca rośnie kwadratowo - skłonność do podział proporcjonalny do n (rozmiar dokumentu) * czas do fix proporcjonalny do rozmiaru n (czas aby naprawić)

• Dlaczego Word jest tak niestabilny: Word robi wiele za kulisami, aby wspieraj początkujących użytkowników i interweniuj w układach. To też nie jest naprawdę frame-based (Przepływ tekstu oddzielony od układu dokumentu), ale deweloperzy starają się wdrożyć różne zachowania podobne do klatek w interfejsie użytkownika. Kiedy A. I. second-guess you on a skomplikowany dokument to często czy zła rzecz. FrameMaker ' traktuje użytkownika jako dorosłego " i nie ma żadnego z to, żeby rzeczy pozostały tam, gdzie się da oni.

  Inne edytory tekstu, takie jak Open Office i WordPerfect nie źle się zachowuje w taki sam sposób jak Słowo, które jest jednym z powodów że prawie każdy słowo procesor inny niż Word zrobi lepsza praca dokumentów technicznych.

• Pre-Flighting: w dokumentacji-mów, jest to proces sprawdzania, że Twój zbiór plików do dokumentu (pliki graficzne itp.) jest poprawne przed / align = "left" / Na profesjonalne systemy będą narzekać o rzeczach, które są złe, dając masz szansę to poprawić. Słowo będzie po prostu przybierał szczęśliwą twarz i spróbuj naprawić rzeczy za kulisami.

  Dobrym tego przykładem jest słowo Plik z połączoną grafiką. Jeśli skopiuj plik i grafikę do kolejny katalog i aktualizacja jednego z grafika in situ, word może dobrze przeczytaj jeszcze Plik z stare path (widziałem to tak) i nie nowy, który właśnie zaktualizowałeś. Zachowanie to nie jest jednak spójne i typuje gwałtowne nadużywanie niestabilna heurystyka w tym produkcie.

• Pre-Press Support: system publikacji rozszerza się na pre-press Faza przepływu pracy. Oznacza to obejmuje przygotowanie do druku. Edytor tekstu nie aby mieć tę funkcjonalność lub mieć to w bardzo ograniczonej formie.

Bez przesady kluczową różnicą jest to, że oprogramowanie do publikowania traktuje cię jak dorosłą osobę, która wyraża zgodę i nie wchodzi w drogę, gdy chcesz skalować lub automatyzować rzeczy. Jeden może używać edytora tekstu do dokumentacji na dużą skalę, ale ma wiele decyzji projektowych dostosowanych do zwykłych Użytkowników piszących krótkie dokumenty z niewielkim uwzględnieniem jakości. Adaptacje te są kosztem przydatności do zadań w pracach związanych z przygotowaniem dokumentów na dużą skalę. Główne problemy, które znajduję w Wordzie dla dokumenty spec to słabe indeksowanie i odsyłacze oraz ogólne Problemy niestabilności, w których zawsze muszę wracać i naprawiać rzeczy. Jednak względy polityczne w większości środowisk (jestem wykonawcą) oznaczają, że często się z tym utkwiło.

Niektóre ogólne uwagi na temat stanu oprogramowania dokumentacji technicznej

Framemaker byłby oczywistym wyborem, gdyby Adobe nie dawało sygnałów, że próbuje go dezaktualizować i przenieść bazę użytkowników do InDesign. Jednak FM jest szeroko stosowany w przemyśle lotniczym, oprogramowaniu i środowiskach inżynierskich, a kierownictwo Adobe musiałoby stawić czoła [268]}lynch mob {3]}, gdyby faktycznie EOL ' d produkt bez wiarygodnej ścieżki migracji. Z tego, co czytamy w Internecie, przejęcie FM przez Adobe było napędzane przez Johna Warnocka, ale został usunięty, a FM stało się ofiarą polityki biurowej. Wynikiem netto jest to, że został przeniesiony do trybu konserwacji i jest dość stagnacji.

Ventura Publisher został również zdegradowany na niszowym rynku w pewnym stopniu, ale przynajmniej Corel nie ma dwóch konkurencyjnych linii produktów w taki sposób, jak Adobe. Jest to prawdopodobnie Przejezdny substytut FM i może być bardziej politycznie akceptowalny dla typów PHB, ponieważ jest sprzedawany jako system "business publishing".

Quicksilver i Arbortext wydają się być produktami opłacalnymi, ale są bardzo drogie. Ja też nie używałem, więc nie mogę naprawdę ocenić ich zalet.

Systemy języka znaczników są wolne i bardzo potężny pod wieloma względami. Może być nieco łatwiejsze do pracy, ponieważ nie ma takiego poziomu bagażu starszego niż LaTeX. DocBook jest również dość szeroko stosowany i ma sporo wsparcia dla narzędzi. Technologie te znacznie ograniczyły "geekowskie" udziały w rynku Framemakera i czynią to w oparciu o swoje zalety - prawdopodobnie przez lata znacznie zmniejszyły marże zysku Adobe. Nie odrzuciłbym tych technologii z ręki, ale one będzie trudniej nauczyć się w praktyce.

Możesz spróbować ocenić program InDesign i wybrany zestaw wtyczek(skoncentruj się na tych do tagowania i zarządzania Cross-ref/index). Wreszcie, niektóre z edytorów tekstu (WordPerfect i OpenOffice) dają rozsądny zestaw narzędzi do strukturyzowanej dokumentacji i działają znacznie lepiej niż MS-Word.

PostScript

Tak, to jest gra słów. Nie dotknąłem jeszcze funkcji Pre-Press żadnego z tych produkty. Druk i Pre-Press to dziedziny techniczne same w sobie, a zakres kosztownych błędów oznacza, że prawdopodobnie powinieneś zostawić to specjalistom. Framemaker, InDesign, Ventura, QuickSilver, Arbortext i (prawdopodobnie) produkty MadCap są wyposażone w urządzenia do przygotowania przed prasą. Ogólnie rzecz biorąc, oprogramowanie do przetwarzania tekstu nie.

Zwróć uwagę, że przestrzeń kolorów RGB monitora nie ma bezpośredniej mapy do koloru CYMK przestrzeń używana przez prasę drukarską. Właściwie uzyskanie kolorów - zwłaszcza kolorowych zdjęć-aby wyszły poprawnie na prasie jest nieco obarczone, jeśli nie masz odpowiedniego zestawu. Jeśli chodzi o produkcję druku, skontaktuj się ze specjalistą, chyba że masz powody, aby sądzić, że wiesz, co robisz. Dla niezobowiązującego użytkownika polecam jeszcze 15 lat po tym, jak byłem zaangażowany w branżę, ponieważ błędy są bardzo kosztowny do naprawy, gdy są zobowiązani do drukowania.

Jeśli naprawdę chcesz aby wykonać wydruk kolorowy w domu, prawdopodobnie będziesz musiał skalibrować swój monitor. Aby uzyskać najlepsze wyniki, powinieneś otrzymać monitor o wysokiej wierności, taki jak ten od HP. Aby skalibrować monitor, Możesz również potrzebować czujnika podobnego do tego opisanego w tej recenzji , Jeśli monitor nie jest dostarczany z takim czujnikiem. Większość profesjonalnych kart graficznych takich jak te z Nvidia, AMD lub Matrox mają możliwości obsługi gamma poprawka; wielu konsumentów również. Będziesz również musiał uzyskać dane kalibracyjne dla prasy, której będziesz używać do drukowania, chociaż prawdopodobnie Dom PrePress będzie w stanie to zrobić.

Jak wspomniano wcześniej, media drukowane są same w sobie dość techniczne, łatwo się pomylić i kosztowne do naprawienia po przejściu do druku. Jeśli nie masz 100% pewności, że kalibracja jest prawidłowa, uzyskaj dowód koloru, taki jak Chromalin . Jest to zrobione z rzeczywistego filmu separacje (a więc jest dość kosztowne), dzięki czemu daje dokładne odwzorowanie rzeczywistego koloru końcowego drukowanego artykułu. W ten sposób na kilku przykładowych stronach otrzymasz dokładną informację zwrotną o tym, czy kalibracja jest prawidłowo skonfigurowana.

Podziękowania: podziękowania dla Aidana Ryana za rozszerzenie sekcji o produktach Madcap.