Dokumentacja i publikacje strukturalne
Pomagam dobrać i wdrożyć model dokumentacji, który odpowiada na realny sposób aktualizacji, reuse treści, lokalizacji oraz publikacji, zamiast wprowadzać XML lub DITA tylko dlatego, że brzmią zaawansowanie.
Dwa modele dokumentacji
DITA nie jest automatycznie najlepszym rozwiązaniem dla każdego dokumentu. Decyzja wynika z materiału, częstotliwości zmian, reuse treści i kanałów publikacji.
Projekt zaczyna się od struktury dokumentacji i modelu informacji: co jest rozdziałem, co powtarzalnym tematem, co należy do konkretnego produktu, a co powinno istnieć tylko raz. Dzięki temu topic-based authoring, reusable content i modularność służą utrzymaniu dokumentacji, a nie są wyłącznie zestawem pojęć.
Mapy DITA, single sourcing i conditional publishing pozwalają ustalić, które topiki, warianty oraz warunki tworzą konkretną publikację. Zasady reuse, typy topiców i nazewnictwo muszą jednak odpowiadać procesowi zespołu oraz decyzjom ekspertów klienta.
Zakres może obejmować projekt modelu DITA, architekturę informacji, typy topiców, mapy, zasady reuse oraz konfigurację publikacji. Dane techniczne, instrukcje produktu i decyzje merytoryczne nadal zatwierdza ekspert klienta; zadaniem procesu jest nadać zatwierdzonej wiedzy strukturę możliwą do utrzymania.
Migracja może prowadzić z Worda lub InDesigna do FrameMakera, z niestrukturalnego FrameMakera do struktury albo z wielu dokumentów do XML/DITA. Przed masowym przeniesieniem trzeba ocenić powtórzenia, braki, style, odsyłacze i treści wymagające czyszczenia.
Migracje i publikacja
PDF, HTML5 i EPUB są rezultatami publikacji, nie zamiennikiem źródła. DITA-OT może być częścią uzgodnionego procesu publikacji.
Proces tej usługi
01
02
03
04
05
06
07
08
Granice odpowiedzialności
Zatwierdza dane techniczne, treści specjalistyczne, definicje produktu i decyzje merytoryczne.
Istniejące narzędzia, wersje oprogramowania, konfiguracje i integracje mogą wpływać na zakres oraz wymagają analizy.
DITA ma sens tylko wtedy, gdy modularność, reuse i publikacja wielokanałowa rozwiązują realny problem dokumentacji.
Przeniesienie źródeł może wymagać czyszczenia treści, ujednolicenia stylów i decyzji o wyjątkach przed automatyzacją.
Powiązane usługi
Tworzenie, aktualizacja, rekonstrukcja PDF i techniczna lokalizacja instrukcji obsługi oraz dokumentacji technicznej.
Tworzenie instrukcji obsługi i dokumentacji technicznej z materiałów oraz wiedzy ekspertów klienta.
Technicznie przygotowuję kolejne wersje językowe istniejącej dokumentacji Adobe FrameMaker, książek, MIF oraz źródeł XML/DITA.
Odpowiedzi pomagają rozdzielić FrameMaker, XML, DITA, migrację i publikację wielokanałową.
FrameMaker ma sens, gdy dokumentacja jest długa, regularnie aktualizowana, zawiera książki, tabele, odsyłacze, zmienne, warianty i wymaga stabilnej publikacji technicznej. Nie jest wyborem dla każdego dokumentu; przy prostych publikacjach Word albo InDesign mogą być wystarczające. Decyzja powinna wynikać z modelu utrzymania dokumentacji, a nie z samej nazwy programu.
Niestrukturalny FrameMaker porządkuje dokument jako pliki, książki, style, szablony i kontrolowany skład. XML/DITA dodaje model informacji, topiki, mapy, reuse treści i publikację z jednego źródła. To drugie wymaga bardziej świadomej architektury i zasad pracy, ale może lepiej działać przy dużej, modułowej dokumentacji.
Nie. Na początku wystarczy opisać dokumentację, sposób aktualizacji, liczbę wariantów, kanały publikacji i problemy obecnego procesu. Po analizie można ustalić, czy wystarczy uporządkowany FrameMaker, czy potrzebny jest model XML/DITA. DITA nie jest automatycznie najlepszym rozwiązaniem dla każdego dokumentu.
Pomagają pliki `.fm`, `.book`, MIF, istniejące Word, InDesign lub PDF, a przy środowisku strukturalnym także XML, DITAMAP, DTD, XSD, EDD i konfiguracje publikacji. Potrzebna jest również informacja o wersjach oprogramowania, kanałach publikacji, reuse treści i osobach zatwierdzających dane merytoryczne. Bez próbki trudno odpowiedzialnie ocenić migrację lub model struktury.
To elementy środowiska, które opisują lub obsługują strukturę dokumentów XML/DITA i sposób ich pracy w FrameMakerze. Nie są osobną usługą ani słownikiem skrótów do wdrożenia na siłę. Mają znaczenie wtedy, gdy dokumentacja ma być walidowana, mapowana, importowana, eksportowana albo publikowana według ustalonego modelu.
Reuse oznacza, że wybrane fragmenty treści mogą być utrzymywane raz i wykorzystywane w wielu miejscach, wariantach albo publikacjach. Publikacja wielokanałowa polega na przygotowaniu źródła tak, aby z jednego modelu można było generować na przykład PDF, HTML5, EPUB lub inny uzgodniony format. Wymaga to zasad nazewnictwa, map, warunków i testów publikacji.
Rezultatem może być uporządkowany dokument FrameMaker, książka, model XML/DITA, próbka struktury, konfiguracja publikacji, dokumentacja rozwiązania albo zmigrowane źródło gotowe do dalszego authoringu. Zakres zależy od tego, czy projekt dotyczy projektowania od podstaw, migracji, porządkowania istniejącego środowiska czy publikacji. Pliki i konfiguracje są przekazywane w uzgodnionym zakresie.
Nie zastępuje wiedzy eksperta klienta, akceptacji treści technicznej ani decyzji produktowych. Nie jest też gwarancją, że każda dokumentacja powinna przejść do DITA. Integracje systemowe, specjalistyczna walidacja danych i zmiany merytoryczne wymagają osobnej analizy oraz właściwych osób po stronie klienta.
W formularzu podaj dostępne źródła, obecne narzędzia, planowany model pracy oraz kanały, do których ma trafiać dokumentacja.