education or translation? go for information

Education or Translation? Go for Information. Transformacja kodu na słowa.Tomasz, Piotr, Marzena, Justyna

Kim jest Technical Writer?

Komunikacja technicznaTomasz 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 dokumentacjiPiotr 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:

Dokumentacja produktu Materiały szkolenioweDokumentacja procesu

Dokumentacja produktu

Materiały szkoleniowe

Dokumentacja procesu

“The single biggest problem with communication is the illusion that it has taken place.”

Proces Tworzenia Marzena Cudecka, SAP Hybris, Technical Writer

Zadanie• Zasady:Podział na grupyAnonimowość (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

SenKawaPrzeczytanie wszystkiego od początku raz jeszcze

Check list: Zawartość KolejnośćGramatyka i literówkiFormatowanie

Rezultat

Projektowanie i edycja dokumentacji technicznejJustyna 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 GuideCzyli 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ładDear 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 blueI 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

Education

collaboration education and test translation program

mis-education, translation and the barkada of …

surface go for education - c2kschools.net · for education....

where does philippine education go

afc coach education futsal coach education afc futsal...

the indonesian translation of “how far i’ll go” a...

research education program knowledge...

go with the flow water education

machine translation - the next ai technology to go...

education: go get it!

go global with this winning combination – content strategy...

ontario education translation （simple chinese）

instant file preparation for translation point and go...

mt and post editing in master's level translation education

collaboration education and test translation program...

when multiwords go bad in machine translation

document translation and language interpreter services...

supported higher education: research translation &...

english-to-czech machine translation: should we go...

where does the education dollar go?