Recenzja DITAWORLD 2022
c-rex.net na DITAWORLD 2022
Trzy dni wypełnione prelekcjami na temat Intelligent Content for an intelligent world
. Takie hasło Adobe wybrało na tegoroczną edycję DITAWORLD 2022.
Według Adobe, ponad 6000 uczestników z całego świata wzięło udział w konferencji online w dniach 10-12 maja 2022 roku.
Program obejmował wykłady, przemówienia i praktyczne raporty dotyczące szerokiego zakresu tematów. Między innymi o DITA, edycji strukturalnej, RoboHelp, Captivate, lokalizacji, mikrotreści, dokumentacji API i wielu innych.
My z c-rex byliśmy tam po raz pierwszy jako Platynowy Sponsor i uczestniczyliśmy w dwóch sesjach w tym roku.
Building Content Bridges. Why Content Needs to Flow Like Water.
W swoim przemówieniu Markus Wiedenmaier wyjaśnia, dlaczego treści muszą płynąć jak woda, dlaczego potrzebne są dwa podejścia do tworzenia treści i że musimy myśleć w kategoriach interfejsów.
W sekcji Budowanie mostów treści Dlaczego treść musi płynąć jak woda.. oto krótkie streszczenie.
Nagranie przemówienia jest dostępne w serwisie YouTube.
Decouple development and documentation processes. API-Documentation - with OpenApi/Swagger, DITA, and AEM
W swoim drugim wykładzie Markus zajmuje się procesami rozwoju i dokumentacji. Tworzenie oprogramowania i pisanie techniczne nie są już silosami. Wręcz przeciwnie, coraz bardziej się do siebie zbliżają. Osoby tworzące oprogramowanie piszą również dokumentację użytkownika. Albo zespół techniczny jest częścią zespołu Scrum i towarzyszy rozwojowi. Ale czy to dobrze, jeśli dokumentacja jest pisana przez zespół programistów?
Odpowiedź Markusa i jego sugestie, jak poradzić sobie z tym problemem w rozsądny sposób, można znaleźć w sekcji Oddzielenie procesów rozwoju i dokumentacji Dokumentacja API - z OpenApi/Swagger, DITA i AEM. oraz w nagraniu wykładu na YouTube.
Buduj mosty i łącz w ten sposób silosy treści. Dlaczego treść musi płynąć jak woda.
Krótkie streszczenie treści wykładu.nagranie wykładu na YouTube
Jeśli firmy prześpią transformację cyfrową, prześpią również zakłócenia. Ale w jaki sposób organizacja może osiągnąć transformację, gdy znajduje się w silosowych strukturach korporacyjnych? Zwłaszcza w dziedzinie dokumentacji technicznej - ale także poza nią? Czysto techniczne otwieranie silosów nie wystarczy. Być może rozbijanie tych silosów w niektórych miejscach przynosi wręcz odwrotny skutek do zamierzonego.
Potrzebujemy raczej dwóch "systemów operacyjnych treści" jako części naszej strategii treści:
Potrzebujemy jednego dla naszych wewnętrznych danych i procesów redakcyjnych.
Powinien być ustrukturyzowany, stabilny i odporny na błędy oraz automatycznie transportować informacje.
Potrzebujemy go do integracji naszego coraz bardziej dynamicznego świata zewnętrznego.
System ten musi rozwijać się w sposób zwinny i elastycznie dostosowywać się do wymagań naszych klientów, użytkowników i rynku.
Musimy myśleć w kategoriach interfejsów: Z technicznego i organizacyjnego punktu widzenia.
Informacje o firmie i produktach muszą przepływać - jak woda - wewnątrz i na zewnątrz firmy do każdego, kto ich potrzebuje, do ludzi, a zwłaszcza do maszyn.
Rozdzielenie procesów rozwoju i dokumentacji. Dokumentacja API z wykorzystaniem OpenApi/Swagger, DITA i AEM
Krótkie streszczenie treści wykładu.nagranie wykładu na YouTube
Tworzenie oprogramowania i pisanie techniczne nie są już silosami. Rozwijają się razem i często dokumentacja użytkownika jest przejmowana przez rozwój oprogramowania.
Ale czy to dobrze, jeśli ludzie tworzący oprogramowanie piszą również dokumentację? Nasza odpowiedź jest jednoznacznie przecząca. W końcu wymaga to specjalistycznej wiedzy w obu dyscyplinach. I zgadnij, kto wygrywa, gdy zbliża się termin, a kod oprogramowania i dokumentacja oprogramowania są pisane przez tę samą osobę? Czy wygrywa wersja oprogramowania lub dokumentacja?
Najlepszą opcją jest posiadanie obu: Ludzie, którzy tworzą oprogramowanie i ludzie, którzy opisują oprogramowanie i zajmują się edycją techniczną. Naszym zadaniem jest inteligentne połączenie obu obszarów, tak aby mogły one działać niezależnie od siebie, a wymiana informacji była jak najbardziej automatyczna. Jeśli pamiętamy również o grupie docelowej, mamy przyszłościowe podejście do tworzenia dokumentacji oprogramowania.
Wykład wykorzysta dokumentację REST API jako przykład, aby pokazać, jak korzystać ze specyfikacji OpenAPI (dawniej Swagger) i DITA oraz zintegrować je z Adobe Experience Manager.
Celem jest oddzielenie procesu dokumentacji, znaczne zmniejszenie potrzeby komunikacji między dwiema domenami i stworzenie koncepcji przyjaznej dla użytkownika dokumentacji API.
Odsyłamy do naszego wpisu na blogu Elastyczna dokumentacja z DITA, w którym opisujemy działanie mechanizmów DITA Reuse.