Kategoria:Dobre praktyki

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….




Dobra dokumentacja – cechy i etapy tworzenia

Dla jednych pisanie dokumentacji to droga przez mękę, dla innych czysta przyjemność i sposób zarabiania na życie. Jednak zarówno ci pierwsi jak i drudzy powinni trzymać się pewnych reguł. Dziś pierwszy z cyklu artykułów, które, mamy nadzieję, pomogą Wam utrzymać jak najwyższy poziom tekstów, a także sprawią, że pisanie nie będzie już takie straszne (dla…




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….




Jak zacząć pisać w DITA – narzędzia

Pisaliśmy już o podstawach dity i o tak zaawansowanym koncepcie jak conkeyref. Teraz chcemy pokazać Wam czego potrzeba, żeby zacząć pisać w dicie. Oczywiście wszystko zaczyna się od gruntownej strategii, o której wspominaliśmy tutaj. Jeśli już ją znacie to pora przejść do zagadnień bardziej praktycznych, czyli narzędzi….