Kategoria:Przykłady

Dokumentacja API – Część 1: Definicja i rodzaje API

Z otwartymi ramionami witamy na naszych stronach nowego autora a wraz z nim nowy, jakże aktualny temat! Marcin przygotował dla Was artykuł otwierający cykl i obiecał, że na tym nie koniec!…




README.md, czyli historia zbyt pomocnego pliku

Kiedy tworzymy dokumentację przyświeca nam cel, żeby dostarczyć użytkownikowi jak najdokładniejsze informacje….




Za co maszyny lubią autorów

Po tłumaczach przyszedł czas na maszyny….




Za co tłumacze lubią autorów – internacjonalizacja

Z przyjemnością publikujemy kolejny wpis gościnny traktujący o tym w jaki sposób specjaliści tworzący dokumentację mogą ułatwić życie tłumaczom….




Za co tłumacze lubią autorów – składaki

Z przyjemnością publikujemy kolejny wpis gościnny traktujący o tym w jaki sposób specjaliści tworzący dokumentację mogą ułatwić życie tłumaczom….




Naucz się sam(a) – część 8

Żyjecie w biegu i coraz częściej doskwiera Wam tzw. „niedoczas”. Ciągle gdzieś chodzicie, jeździcie i biegacie. Chcecie pogodzić ze sobą pracę zawodową, życie rodzinne, aktywność fizyczną i rozwój swoich umiejętności, ale doba ma tylko 24 godziny….




Za co tłumacze lubią autorów – spójność

Nieraz mieliśmy okazję słyszeć Tech Writerów, którzy narzekali na swój ciężki los, bo SMEsi nie chcieli z nimi współpracować. A jak już chcieli, to nie stosowali dobrych praktyk i dostarczali im zdawkowe i trudne do przetrawienia informacje naszpikowane wszelkiej maści osobliwościami językowymi….




Diagramy generowane z plików DITA? Tak! I nie tylko…

W DITA można pisać treść z multimediami a potem generować z niej HMTLe, PDFy i tak dalej. A co, gdybyśmy chcieli na przykład wygenerować diagram z drzewa procedur? Na szczęście się da….




Noty wydania (Release Notes) – co, jak, dla kogo?

Dość dawno temu pisaliśmy pokrótce o notach wydania (release notes). Dzisiaj przyjrzymy się im trochę bliżej….




zdjęcie człowieka skaczącego do wody

DITA conkeyref – Pracuj sprytnie a nie ciężko

Pisaliśmy już o podstawach i tworzeniu strategii dla DITA. Po tym łagodnym wprowadzeniu, postanowiliśmy Was rzucić na głęboką wodę, czyli zająć się zagadnieniem conkeyref. Dzięki temu zapoznacie się z koncepcją kluczy i pobierania treści w dicie. Dla ułatwienia posłużymy się praktycznym przykładem, który mamy nadzieję pozwoli Wam szybko zrozumieć o co w tym wszystkim chodzi….