education or translation? go for information
TRANSCRIPT
![Page 1: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/1.jpg)
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.
![Page 2: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/2.jpg)
Kim jest Technical Writer?
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 3: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/3.jpg)
Komunikacja technicznaTomasz Pietrek, SAP Hybris, Senior DevOps Engineer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 4: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/4.jpg)
Odbiorca
• Kto jest obiorcą?
• Przedział wiekowy
• Poziom wiedzy
• Oczekiwana forma
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 5: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/5.jpg)
Cel i kontekst
• Jaki jest cel naszego przekazu?
• W jakiej sytuacji nasz dokument
będzie czytany?
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 6: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/6.jpg)
Kto to jest Technical Writer?Justyna Adamczyk, SAP Hybris, Technical Writer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 7: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/7.jpg)
Pierwsze skojarzenie
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 8: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/8.jpg)
Technical Writer jako detektyw
Przegląda zadania zespołu, zmiany kodu, planningi, dema
Kontaktuje się z PO
Zdobywa wiedzę na temat przyszłych zmian
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 9: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/9.jpg)
Technical Writer jako negocjator
Kontaktuje się z developerami
Próbuje zdobyć ich uwagę ;)
Trening dla TW
![Page 10: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/10.jpg)
Technical Writer jako tłumacz
„Tłumaczenie kodu na słowa”
Prosty język
Firmowa terminologia, zatwierdzona przez marketing
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 11: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/11.jpg)
Technical Writer jako grafik
Tworzenie ilustracji, grafik, screenshotów
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 12: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/12.jpg)
Technical Writer jako tester
Przeprowadzanie smoke-testów podczas tworzenia dokumentacji
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 13: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/13.jpg)
Technical Writer jako pisarz
Projektowanie dokumentacji / dokumentów
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 14: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/14.jpg)
Typy dokumentacjiPiotr Oszenda, SAP Hybris, Technical Writer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 15: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/15.jpg)
To jest dokumentacja techniczna:
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 16: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/16.jpg)
Oceń jakość dokumentacji tego produktu: Zadanie z cyklu: “zrób to sam”
Percepcyjna (Perceivable)
Funkcjonalna (Operable)
Zrozumiała (Understandable)
Rzetelna (Robust)
?
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 17: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/17.jpg)
Oceń jakość dokumentacji tego produktu: Zadanie
?
Percepcyjna (Perceivable)
Funkcjonalna (Operable)
Zrozumiała (Understandable)
Rzetelna (Robust)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 18: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/18.jpg)
Jakie są typy dokumentacji techniczej?
+ dobra - zła
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 19: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/19.jpg)
Przykład dobrej dokumentacji, bez fajerwerków:
https://payroll.intuit.com/support/ © 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 20: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/20.jpg)
Dokumentacja produktu Materiały szkolenioweDokumentacja procesu
![Page 21: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/21.jpg)
Dokumentacja produktu
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 22: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/22.jpg)
Materiały szkoleniowe
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 23: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/23.jpg)
Dokumentacja procesu
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 24: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/24.jpg)
“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.
![Page 25: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/25.jpg)
Proces Tworzenia Marzena Cudecka, SAP Hybris, Technical Writer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 26: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/26.jpg)
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
![Page 27: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/27.jpg)
Planowanie • Odbiorcy: kto to będzie czytał?
• Zawartość: określenie potrzeb i polowanie na input
• Układanie danych
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 28: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/28.jpg)
Proces Twórczy• Wstęp – short description
• Treść – the meat
• Przykłady i obrazki – see how it works
• Zakończenie – Referals
![Page 29: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/29.jpg)
… ciąg dalszy procesu twórczego
SenKawaPrzeczytanie wszystkiego od początku raz jeszcze
Check list: Zawartość KolejnośćGramatyka i literówkiFormatowanie
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 30: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/30.jpg)
Rezultat
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 31: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/31.jpg)
Projektowanie i edycja dokumentacji technicznejJustyna Adamczyk, SAP Hybris, Technical Writer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 32: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/32.jpg)
Agenda• Zanim powstanie dokumentacja• Projektowanie dokumentacji• Projektowanie dokumentu• Weryfikacja dokumentacji• Piszemy!!!• Style Guide
![Page 33: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/33.jpg)
Zanim powstanie dokumentacja
• Rodzaje dokumentów• Odbiorcy dokumentacji
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 34: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/34.jpg)
Zanim powstanie dokumentacja
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 35: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/35.jpg)
Projektowanie dokumentacji• Tytuły głównych rozdziałów i dokumentów• Wpływ na istniejące dokumenty• Rodzaje dokumentów
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 36: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/36.jpg)
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
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 37: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/37.jpg)
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)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 38: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/38.jpg)
Piszemy!!!
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 39: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/39.jpg)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 40: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/40.jpg)
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.
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 41: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/41.jpg)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 42: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/42.jpg)
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ę
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 43: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/43.jpg)
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
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 44: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/44.jpg)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 45: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/45.jpg)
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
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 46: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/46.jpg)
Ścieżka rozwoju• Senior/2nd level• Tester/QA• PM, PO, Business Analyst• Marketing communications• UI/UX• Technology related fields• Technology articles/books writer
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 47: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/47.jpg)
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
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 48: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/48.jpg)
Education or Translation? Go for Information. Transformacja kodu na słowa.Information Developer: (the)coder
Tomasz, Piotr, Marzena, Justyna
© 2016 SAP SE or an SAP affiliate company. All rights reserved.
![Page 49: Education or Translation? Go for Information](https://reader038.vdocuments.net/reader038/viewer/2022102703/5882c83c1a28abb2478b73ef/html5/thumbnails/49.jpg)
© 2016 SAP SE or an SAP affiliate company. All rights reserved.