Education or Translation? Go for Information.

Education or Translation?
Go for Information.
Transformacja kodu na
słowa.
Tomasz, Piotr, Marzena, Justyna
© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Kim jest Technical Writer?

Komunikacja techniczna
Tomasz Pietrek, SAP Hybris, Senior DevOps Engineer

Odbiorca
• Kto jest obiorcą?
• Przedział wiekowy
• Poziom wiedzy
• Oczekiwana forma

Cel i kontekst
• Jaki jest cel naszego przekazu?
• W jakiej sytuacji nasz dokument
będzie czytany?

Kto to jest Technical
Writer?
Justyna Adamczyk, SAP Hybris, Technical Writer

Pierwsze skojarzenie

Technical Writer jako detektyw
Przegląda zadania zespołu, zmiany kodu,
planningi, dema
Kontaktuje się z PO
Zdobywa wiedzę na temat przyszłych
zmian

Technical Writer jako negocjator
Kontaktuje się z developerami
Próbuje zdobyć ich uwagę ;)
Trening dla TW

Technical Writer jako tłumacz
„Tłumaczenie kodu na słowa”
Prosty język
Firmowa terminologia,
zatwierdzona przez marketing

Technical Writer jako grafik
Tworzenie ilustracji, grafik,
screenshotów

Technical Writer jako tester
Przeprowadzanie smoke-
testów podczas tworzenia
dokumentacji

Technical Writer jako pisarz
Projektowanie dokumentacji /
dokumentów

Typy dokumentacji
Piotr Oszenda, SAP Hybris, Technical Writer

To jest dokumentacja techniczna:

Oceń jakość dokumentacji tego produktu:
Zadanie z cyklu: “zrób to sam”
Percepcyjna (Perceivable)
Funkcjonalna (Operable)
Zrozumiała
(Understandable)
Rzetelna (Robust)
?

Oceń jakość dokumentacji tego produktu:
Zadanie
?
Percepcyjna (Perceivable)
Funkcjonalna (Operable)
Zrozumiała
(Understandable)
Rzetelna (Robust)

Jakie są typy dokumentacji techniczej?
+ dobra - zła

Przykład dobrej dokumentacji, bez fajerwerków:
https://payroll.intuit.com/support/ © 2016 SAP SE or an SAP affiliate company. All rights reserved.

Dokumentacja produktu Materiały szkoleniowe
Dokumentacja procesu

Dokumentacja produktu

Materiały szkoleniowe

Dokumentacja procesu

“The single biggest problem with
communication is the illusion that
it has taken place.”
G.B. Shaw © 2016 SAP SE or an SAP affiliate company. All rights reserved.

Proces Tworzenia
Marzena Cudecka, SAP Hybris, Technical Writer

Zadanie
• Zasady:
Podział na grupy
Anonimowość (grupa A, B, C etc.)
Czas: 10 min
• Treść:
a) przygotuj dokumentację opisującą funkcję wysyłania sms-a z telefonu
komórkowego
b) weź pod uwagę PODSTAWOWE informacje i opisz w kilku punktach jak
przebiega proces, co użytkownik musi zrobić żeby wysłać wiadomość,
model telefonu nie jest ważny, najważniejsze jest zaplanowanie i
uwzględnienie istotnych informacji

Planowanie • Odbiorcy: kto to będzie czytał?
• Zawartość: określenie potrzeb i
polowanie na input
• Układanie danych

Proces Twórczy
• Wstęp – short description
• Treść – the meat
• Przykłady i obrazki – see
how it works
• Zakończenie – Referals

… ciąg dalszy procesu twórczego
Sen
Kawa
Przeczytanie wszystkiego od początku raz jeszcze
Check list:
Zawartość
Kolejność
Gramatyka i literówki
Formatowanie

Rezultat

Projektowanie i edycja
dokumentacji technicznej
Justyna Adamczyk, SAP Hybris, Technical Writer

Agenda
• Zanim powstanie dokumentacja
• Projektowanie dokumentacji
• Projektowanie dokumentu
• Weryfikacja dokumentacji
• Piszemy!!!
• Style Guide

Zanim powstanie dokumentacja
• Rodzaje dokumentów• Odbiorcy dokumentacji

Zanim powstanie dokumentacja

Projektowanie dokumentacji
•Tytuły głównych rozdziałów i dokumentów
•Wpływ na istniejące dokumenty
•Rodzaje dokumentów

Projekt dokumentu
• Tytuł dokumentu
• Rozmiar sekcji
(paragrafów)
• Strona tytułowa
• Historia zmian
dokumentu
• Spis treści
• Wstęp
• Rozwinięcie
• Dodatkowe sekcje
• Powiązane sekcje

Weryfikacja dokumentacji
• Przeczytanie dokumentu w poszukiwaniu błędów
• Sprawdzenie aktualności screenshotów
• Peer-review
• Przekazanie dokumentu do weryfikacji przez SMEs (Subject Matters
Experts)

Piszemy!!!

Style Guide
Czyli zbiór, który definiuje:
• jakiego języka używać,
• jak mają wyglądać tabelki,
• listy,
• jak duże mają być screenshoty,
• jak powinny być skonstruowane
zdania,
• jak używać znaków interpunkcyjnych
• i wiele innych.

Doświadczenie Użytkownika
• Użyta terminologia jest zrozumiała dla czytelnika i spójna z
terminologią używaną w produkcie
• Każdy dokument ma jasno zdefiniowany cel i przeznaczenie
• Informacje można znaleźć łatwo i efektywnie
• Wszystkie dokumenty są spójne, stworzone w tym samym
standardzie. Treść dokumentów nie powtarza się

Przykład
Dear Aunt Bee,
I wanted to thank you so much for the beautiful new angora sweater
you sent me for my birthday! I can’t believe you remembered that
blue is my absolute favourite colour (especially that gorgeous shade
of robin’s egg blue, which reminds me of the summers I spent with
you in the country, all those years ago)! I’ll think of you whenever I
wear it. I really appreciate the time and effort you took to pick this
out, wrap it so nicely, and send it to me.
With lots of love, your niece,
Suzanne

Dear Aunt Bee,
Thanks for the sweater. It is:
 warm
 soft
 blue
I think of you when I wear the sweater. I appreciate your
kindness.
Sincerely,
Suzanne

Ścieżka rozwoju
• Senior/2nd level
• Tester/QA
• PM, PO, Business Analyst
• Marketing communications
• UI/UX
• Technology related fields
• Technology articles/books writer

Konferencje dla Technical Writerów
• Europa
• UA Europe 2016: Tech Writing - Budapeszt
• Write the Docs – Praga
• Tecom – Stuttgart
• Polska
• SOAP - Kraków
• Stany Zjednoczone
• MadWorld – San Diego, CA
• ConveyUX - Seattle, WA
• WritersUA West – Silicon Valley, CA
• Elevate Summit – Austin, TX

Education or Translation? Go for
Information. Transformacja kodu
na słowa.
Information Developer: (the)coder
Tomasz, Piotr, Marzena, Justyna

Education or Translation? Go for Information.

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (12)

Similar to Education or Translation? Go for Information.

Similar to Education or Translation? Go for Information. (20)

Education or Translation? Go for Information.

Editor's Notes