60 artykułów z tagiem "przyklady"

Bycie Technical Writerem jest fajne. Przynajmniej według nas. Jest to zawód nietuzinkowy, dający satysfakcję i poszerzający wiedzę techniczną, szczególnie dla osób, które ukończyły studia humanistyczne. Jednak nie zawsze jest tak różowo. Dzisiaj chcemy wylać trochę żali i podzielić się z Wami tym, z czym Technical Writer musi się mierzyć. Dla jednych są to problemy, dla innych wyzwania. Bez względu na to, jakiego określenia użyjemy, są to "ciemne strony" tego zawodu, o których też trzeba mówić. Dzięki temu możemy podpowiedzieć innym jak sobie radzić w trudnych sytuacjach. Problemy są różne, dlatego nasza lista w żadnym wypadku nie wyczerpuje tematu. Jest to jedynie zestawienie, które zbudowaliśmy na podstawie własnych doświadczeń. Nie chcemy nikogo zniechęcać do zawodu Technical Writera, a jedynie uświadomić, że to nie zawsze plaża i drinki ze słomką 😉

Jedną z cech dobrego Technical Writera jest umiejętność pisania. Na tą umiejętność składają się różne elementy, takie jak prezentowanie informacji w sposób jasny i zrozumiały czy też uporządkowanie ich w logiczny sposób. Ale to nie wszystko. Liczy się również poprawność językowa. Pomimo tego, że jest ona na pewno mniej ważna niż dokładność przedstawianych informacji, to nie powinniśmy o niej zapominać. Wiadomo, w sytuacji kiedy mamy napięte terminy i musimy z czegoś zrezygnować, lepiej jest stworzyć dokumentację zawierającą błędy językowe, ale dokładną pod względem technicznym niż wzór poprawności językowej, który opisuje produkt "po łebkach".

Zgodnie z obietnicą, prezentujemy drugą porcję przydatnych informacji z książki „Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation” autorstwa Alana S. Pringle i Sarah S. O’Keefe. Jest to kontynuacja dobrych rad, które przedstawiliśmy w poprzednim wpisie z cyklu "Naucz się sam(a)".

Nadszedł czas, żeby zabrać się za zawartość przesyłki, którą opisywaliśmy w poprzednim wpisie z cyklu "Naucz się sam(a)". Zaczynamy od książki "Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation" autorstwa Alana S. Pringle i Sarah S. O'Keefe.

A może po prostu Style Guide lub Style Manual? Dowiedz się co to jest, sprawdź do czego i kiedy jest potrzebne, stwórz Style Guide dla swojej organizacji. O ile jeszcze go nie ma.