57 artykułów z tagiem "dokumentacja"

Dziś temat bliski wszystkim Technical Writerom, a mianowicie dokumentacja.

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

Mamy dziś dla Was kolejną porcję informacji z zakresu standardów języka angielskiego, jakie można wykorzystać w tworzeniu dokumentacji. Tym razem na tapetę bierzemy Simplified Technical English. Czym jest? Skąd się wziął? Dlaczego warto z niego korzystać? Odpowiedzi na te pytania znajdziecie poniżej.

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 naszych poprzednich artykułach tutaj i tutaj. Pisanie prostym językiem może zatem oszczędzić nam czas i pieniądze. Pomoże nam również zastosować przekazane informacje oraz ocalić drzewa 😊. Co jeszcze możemy zyskać dzięki korzystaniu z dobrodziejstw prostego języka?

Ostatnio dużo pisaliśmy o tworzeniu dokumentacji API, wiec teraz dla odmiany napiszemy trochę o tym jak sobie pomóc w tworzeniu dokumentacji maszynowej.