#64 Tech Writer czepia się DITY, czyli jak tworzyć treść, która się dobrze wyszukuje
Standard DITA, czyli Darwin Information Typing Architecture, nie jest zły sam w sobie, ale może skłaniać nas do stosowania pewnych praktyk, które wpływają negatywnie na wyszukiwanie. Przykładem mogą być strony, które mają bardzo mało treści, przez co nie są zbyt pomocne, a jednocześnie zabierają cenne miejsce na liście wyników wyszukiwania. Kolejną kwestią jest ponownie wykorzystanie treści, czyli reuse. Jest to temat szeroki a problemy z nim związane dotyczą nie tylko standardu DITA.Rozmawiamy o tym co powoduje, że wyniki wyszukiwania nie są pomocne, złych praktykach w tworzeniu dokumentacji w wersji webowej, problemach z reusem i potencjalnych rozwiązaniach.Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).Informacje dodatkowe: "Darwin Information Typing Architecture", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture Post Pawła na LinkedIn: https://www.linkedin.com/feed/update/urn:li:activity:7176518908634439680 "Content reuse – a productivity booster or a vicious circle?", JetBrains blog: https://blog.jetbrains.com/writerside/2022/08/content-reuse-a-productivity-booster-or-a-vicious-circle/ "Chunking", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html "Definition of DITA maps", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/definition-of-ditamaps.html "Every Page is Page One: Topic-based Writing for Technical Communication and the Web", Mark Baker: http://xmlpress.net/publications/eppo/ "Topic-based authoring", Wikipedia: https://en.wikipedia.org/wiki/Topic-based_authoring "Single-source publishing", Wikipedia: https://en.wikipedia.org/wiki/Single-source_publishing
Redaktor opowiada o swoim postawieniu w roli opozycjonisty DITY.
Redaktor krytykuje DITY ze względu na trudności w tworzeniu stron internetowych.
Redaktor wyjaśnia swoje krytyczne podejście do DITY w kontekście dokumentacji elektronicznej.
Redaktor analizuje przeszłość i obecność DITY w kontekście dokumentacji drukowanej.
Redaktor omawia problemy z nawigacją i wyszukiwaniem w dokumentacji DIT-owej.
Redaktor przedstawia wyniki analizy zachowania użytkowników podczas korzystania z dokumentacji DIT-owej.
Redaktor omawia problemy związane z krótkimi topikami i re-use w kontekście wyszukiwania.
Redaktor przedstawia propozycje rozwiązania problemu z krótkimi topikami poprzez chunking.
Redaktor i gość dyskutują nad innymi możliwościami poprawy wyszukiwania w dokumentacji DIT-owej.
Rozmowa na temat chunkingu, reużywania treści oraz dynamicznego ładowania treści w dokumentacji technicznej. Dyskusja nad konsekwencjami dla indeksowania przez wyszukiwarki i alternatywnymi rozwiązaniami.
Refleksje na temat złożoności procesu dokumentacji technicznej, potrzeby dostosowania treści do różnych formantów i urządzeń oraz propozycja organizacji panelu dyskusyjnego na temat dokumentacji.
Rozdziały i streszczenia generowane automatycznie. Pełna transkrypcja nie jest publikowana — wyszukaj frazę, aby zobaczyć dopasowane fragmenty.
Standard DITA, czyli Darwin Information Typing Architecture, nie jest zły sam w sobie, ale może skłaniać nas do stosowania pewnych praktyk, które wpływają negatywnie na wyszukiwanie. Przykładem mogą być strony, które mają bardzo mało treści, przez co nie są zbyt pomocne, a jednocześnie zabierają cenne miejsce na liście wyników wyszukiwania. Kolejną kwestią jest ponownie wykorzystanie treści, czyli reuse. Jest to temat szeroki a problemy z nim związane dotyczą nie tylko standardu DITA.
Rozmawiamy o tym co powoduje, że wyniki wyszukiwania nie są pomocne, złych praktykach w tworzeniu dokumentacji w wersji webowej, problemach z reusem i potencjalnych rozwiązaniach.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
Informacje dodatkowe:
"Darwin Information Typing Architecture", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture Post Pawła na LinkedIn: https://www.linkedin.com/feed/update/urn:li:activity:7176518908634439680 "Content reuse – a productivity booster or a vicious circle?", JetBrains blog: https://blog.jetbrains.com/writerside/2022/08/content-reuse-a-productivity-booster-or-a-vicious-circle/ "Chunking", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html "Definition of DITA maps", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/definition-of-ditamaps.html "Every Page is Page One: Topic-based Writing for Technical Communication and the Web", Mark Baker: http://xmlpress.net/publications/eppo/ "Topic-based authoring", Wikipedia: https://en.wikipedia.org/wiki/Topic-based_authoring "Single-source publishing", Wikipedia: https://en.wikipedia.org/wiki/Single-source_publishing