Category: Przykłady

Simplified Technical English (STE) – jak go używać w praktyce

Jakiś czas temu pisaliśmy o podstawowych zasadach użycia kontrolowanego języka angielskiego (Simplified Technical English). W tym artykule dowiecie się więcej dlaczego i jak go używać….




Inspiracje dla Technical Writera – dokumentacja online

Dziś mamy dla Was kilka konkretnych przykładów dokumentacji online, w ramach poszerzania horyzontów 🙂…




Prosty język – przykłady i narzędzia

Wszyscy jesteśmy zajęci i często nie chcemy tracić czasu na zrozumienie trudnych, rozwlekłych dokumentów. Analizy różnych tekstów potwierdziły, że nietypowe słowa i długość zdań, były jedną z pierwszych przyczyn trudności w czytaniu i rozumieniu tekstu. Wiemy, że w prostym języku (ang. plain language) ważne są – budowa zdań i dobór słownictwa, o czym pisaliśmy już w…




Pisz dla Linode – program stworzony z myślą o freelancerach z branży

Mamy dziś dla Was propozycję ciekawej, wirtualnej biblioteki, której zasoby możecie nie tylko przeglądać, ale też tworzyć, nie wstając z fotela. Szczegóły poniżej. Zapraszamy!…




E-learning – przykład z życia

Zbyt rzadko wspominamy o szkoleniach, będących ważną odmianą komunikacji technicznej. Dziś naprawiamy ten błąd….




O pisaniu gamingowego kontentu słów kilka

Opuszczamy nasze swojskie poletko, żeglując trochę w stronę copywritingu i publicystyki specjalistycznej….


Tagi:


Dokumentacja API – trendy

API nAPIera 😉 Czego się spodziewać i na czym wzorować tworząc tego typu dokumentację? Wygrzebaliśmy dla Was trochę przydatnych informacji….




Dokumentowanie API – Część 2: Dokumentacja referencyjna

Kontynuujemy temat dokumentacji API – przed Wami drugi artykuł Marcina Pierzchały. Tym razem skupiamy się na części referencyjnej dokumentacji….




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