<commit_before># Komunikacja Techniczna
### <NAME> | <NAME>
Note: Komunikacja Techniczna



![Unit4](https://upload.wikimedia.org/wikipedia/commons/0/0b/Unit4_LogoLockup_RGB_Final.jpg)



![Dolby logo](http://logok.org/wp-content/uploads/2014/05/Dolby-logo.png)



## Technical Communication
### Komunikacja Techniczna



* **STC:** Any form of communication that focuses on technical or specialized topics, communicates specifically by using technology or provides instructions on how to do something.
* **ISTC:** Factual communication, usually about products and services.
* **EATC:** The process of defining, creating and delivering information products for the safe, efficient and effective use of products (technical systems, software, services).
Note:  Society for Technical Communication, Institute of Scientific and Technical Communicators, European Association for Technical Communication



![Knowledge transfer](https://solutions21.com/wp-content/uploads/2016/05/blog_KnowledgeTransfer_Buddy_fb-1024x536.jpg)



### **Jakie są tipy dokumentacji techniczny?**<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
# **Dobra**<!-- .element: style="font-family: 'Lato', Impact, sans-serif; color: #4CAF50"  class="fragment" data-fragment-index="1" --> **Zła**<!-- .element: style="font-family: 'Lato', Impact, sans-serif; color: #F44336" class="fragment" data-fragment-index="2" -->
Note: Czy robi to, co chcemy?



### Dokumentacja techniczna
- Instrukcje obsługi
- Specifikacje
- Pomoc/Wsparcie
- Knowledge Bases
- eLearning
Note: Kanał dostarczania - PDF? Papier? HTML? Github?



### Produkt
- Hardware vs Software
- Deliverable vs Service
- Professional vs Consumer



### Odbiorca
- Wewnętrzny/Zewnętrzny
- Poziom wiedzy
- Oczekiwana forma
- Aspekty kulturowe
Note: tłumaczyć? humor?



### Cel i kontekst
- Jaki jest cel naszego przekazu?
- W jakiej sytuacji nasz dokument będzie używany?
Note: Ile chcemy/możemy mówić?



## Kim jest Technical Writer?
Note: Pisarz techniczny, Information developer, Documentarian...



### Technical Writer: Detektyw<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Detective](https://www.earthrangers.com/content/wildwire/detective.png)
Note: Detectyw: powód zmian, źródła wiedzy, historie



### Technical Writer: Negocjator<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Negotiation](https://cdn.munplanet.com/storage/uploads/52209627db7c13603b000001/topic/background_image/52e14088db7c1397780008a1/Negotiation.jpg)
Note: Negocjator: devs, biznes, równoległych projektów



### Technical Writer: Tłumacz<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Translator](http://icons.iconarchive.com/icons/marcus-roberto/google-play/512/Google-Translate-icon.png)
Note: Tłumacz: terminologia firmowa/branżowa, poziom wiedzy, lokalizacja...



### Technical Writer: Grafik<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Designer](https://usabilitygeek.com/wp-content/uploads/2014/03/when-to-prototype-when-to-wireframe-fidelity.jpg)
Note: Grafik: terminologia firmowa/branżowa, poziom wiedzy, lokalizacja...



### Technical Writer: Tester<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Tester](https://nexiilabs.com/blog/wp-content/uploads/2014/05/shutterstock_codebug.jpg)
Note: Tester: UI, hardware, log bugs...



### Technical Writer: Architekt<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Architect](http://sagitas.com/wp-content/uploads/2016/10/plans.png)
Note: Architekt: Information architecture, struktura, granulacja



### Technical Writer
- Detektyw
- Negocjator
- Tłumacz
- Grafik
- Tester
- Architekt



### Tworzenia dokumentacji
* Zanim powstanie dokumentacja<!-- .element: class="fragment" data-fragment-index="1" -->
* Projektowanie documentacji<!-- .element: class="fragment" data-fragment-index="2" -->
* Tworzenia treści<!-- .element: class="fragment" data-fragment-index="3" -->
* Weryfikacja<!-- .element: class="fragment" data-fragment-index="4" -->
* Publikacja<!-- .element: class="fragment" data-fragment-index="5" -->



### Zanim powstanie dokumentacja
* Kim jest odbiorca
* Rodzaje dokumentów
* Zagadnienia prawne<!-- .element: class="fragment" data-fragment-index="1" -->
* Planowanie czasu i zasobów<!-- .element: class="fragment" data-fragment-index="1" -->
* Definicja ról<!-- .element: class="fragment" data-fragment-index="1" -->
Note: Z kim będziemy współpracować, kiedy mamy termin.



### Projektowanie documentacji
* Kanał dostarczania
* Typu dokumentu
* Spis treści
* Rozmiar sekcji
* Referencje<!-- .element: class="fragment" data-fragment-index="1" -->
* "Accessibility"<!-- .element: class="fragment" data-fragment-index="2" -->
* "Reuse" i "single-sourcing"<!-- .element: class="fragment" data-fragment-index="3" -->
Note: Accessibility, Dostępność,



### **Tworzenia treści**<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
* Narzędzia
* Standardy
* Księga stylu (Styleguide)
Note: CMS, static site generators, DITA, madcap



### Weryfikacja
* SME-review (Subject Matter Expert)
* Peer-review
* QA/Testers
* Sign-off
Notes: Korygowanie



### Publikacja
* Lokalizacja
* Wydruk
* Platforma dostępu
Notes: ogólno dostępny czy dla klientów...



![RTFM2](http://s2.quickmeme.com/img/c1/c1fa1ad064066b5c2ce7f4cfe448c742bdc1451557e3f8c15d6db50aede8758d.jpg)



![RTFM](https://pbs.twimg.com/media/Cgd7ixyXEAAaN1Z.jpg)<commit_msg>Update content.md<commit_after># Komunikacja Techniczna
### <NAME> | <NAME>
Note: Komunikacja Techniczna



![Unit4](https://upload.wikimedia.org/wikipedia/commons/0/0b/Unit4_LogoLockup_RGB_Final.jpg)



![Dolby logo](http://logok.org/wp-content/uploads/2014/05/Dolby-logo.png)


### MeetContentWRO
![soap logo](http://soapconf.com/wp-content/uploads/2017/02/logo.png2)
Note: Co my we dwóch robimy...



## Technical Communication
### Komunikacja Techniczna



* **STC:** Any form of communication that focuses on technical or specialized topics, communicates specifically by using technology or provides instructions on how to do something.
[//]: # (* **ISTC:** Factual communication, usually about products and services.)
[//]: # (* **EATC:** The process of defining, creating and delivering information products for the safe, efficient and effective use of products (technical systems, software, services).)
Note:  Society for Technical Communication, Institute of Scientific and Technical Communicators, European Association for Technical Communication



![Knowledge transfer](https://solutions21.com/wp-content/uploads/2016/05/blog_KnowledgeTransfer_Buddy_fb-1024x536.jpg)



### **Jakie są typy dokumentacji technicznej?**<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
# **Dobra**<!-- .element: style="font-family: 'Lato', Impact, sans-serif; color: #4CAF50"  class="fragment" data-fragment-index="1" --> **Zła**<!-- .element: style="font-family: 'Lato', Impact, sans-serif; color: #F44336" class="fragment" data-fragment-index="2" -->
Note: Czy robi to, co chcemy?



### Dokumentacja techniczna
- Instrukcje obsługi
- Specifikacje
- Pomoc/Wsparcie
- Knowledge Bases
- eLearning
Note: Kanał dostarczania - PDF? Papier? HTML? Github?



### Produkt
- Hardware vs Software
- Deliverable vs Service
- Professional vs Consumer



### Odbiorca
- Wewnętrzny / Zewnętrzny
- Poziom wiedzy
- Oczekiwana forma
- Aspekty kulturowe
Note: tłumaczyć? humor?



### Cel i kontekst
- Jaki jest cel naszego przekazu?
- W jakiej sytuacji nasz dokument będzie czytany?
Note: Ile chcemy/możemy mówić?



## Kim jest Technical Writer?
Note: Pisarz techniczny, Information developer, Documentarian...



### Technical Writer: Detektyw<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Detective](https://www.earthrangers.com/content/wildwire/detective.png)
Note: Detectyw: powód zmian, źródła wiedzy, historie



### Technical Writer: Negocjator<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Negotiation](https://cdn.munplanet.com/storage/uploads/52209627db7c13603b000001/topic/background_image/52e14088db7c1397780008a1/Negotiation.jpg)
Note: Negocjator: devs, biznes, równoległych projektów



### Technical Writer: Tłumacz<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Translator](http://icons.iconarchive.com/icons/marcus-roberto/google-play/512/Google-Translate-icon.png)
Note: Tłumacz: terminologia firmowa/branżowa, poziom wiedzy, lokalizacja...



### Technical Writer: Grafik<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Designer](https://usabilitygeek.com/wp-content/uploads/2014/03/when-to-prototype-when-to-wireframe-fidelity.jpg)
Note: Grafik: terminologia firmowa/branżowa, poziom wiedzy, lokalizacja...



### Technical Writer: Tester<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Tester](https://nexiilabs.com/blog/wp-content/uploads/2014/05/shutterstock_codebug.jpg)
Note: Tester: UI, hardware, log bugs...



### Technical Writer: Architekt<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Architect](http://sagitas.com/wp-content/uploads/2016/10/plans.png)
Note: Architekt: Information architecture, struktura, granulacja



### Technical Writer
- Detektyw
- Negocjator
- Tłumacz
- Grafik
- Tester
- Architekt



### Tworzenie dokumentacji
* Zanim powstanie dokumentacja<!-- .element: class="fragment" data-fragment-index="1" -->
* Projektowanie dokumentacji<!-- .element: class="fragment" data-fragment-index="2" -->
* Tworzenie treści<!-- .element: class="fragment" data-fragment-index="3" -->
* Weryfikacja<!-- .element: class="fragment" data-fragment-index="4" -->
* Publikacja<!-- .element: class="fragment" data-fragment-index="5" -->
* Utrzymanie<!-- .element: class="fragment" data-fragment-index="6" -->



### Zanim powstanie dokumentacja
* Kim jest odbiorca?
* Rodzaje dokumentów
* Zagadnienia prawne<!-- .element: class="fragment" data-fragment-index="1" -->
* Planowanie czasu i zasobów<!-- .element: class="fragment" data-fragment-index="1" -->
* Definicja ról<!-- .element: class="fragment" data-fragment-index="1" -->
Note: Z kim będziemy współpracować, kiedy mamy termin.



### Projektowanie dokumentacji
* Kanał dostarczania
* Typy dokumentu
* Spis treści
* Rozmiar sekcji
* Referencje<!-- .element: class="fragment" data-fragment-index="1" -->
* "Accessibility"<!-- .element: class="fragment" data-fragment-index="2" -->
* "Reuse" i "single-sourcing"<!-- .element: class="fragment" data-fragment-index="3" -->
Note: Accessibility, Dostępność,



### **Tworzenie treści**<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
* Narzędzia
* Standardy
* Księga stylu (Styleguide)
Note: CMS, static site generators, DITA, madcap



### Weryfikacja
* SME-review (Subject Matter Expert)
* Peer-review
* QA/Testers
* Sign-off
Notes: Korygowanie



### Publikacja
* Lokalizacja
* Wydruk
* Platforma dostępu
Notes: ogólno dostępny czy dla klientów...

### Utrzymanie
* Poprawa błędów
* Nowe wersje funkcjonalności
* Adaptacja produktu
* Wersjonowanie dokumentów
Notes: wprowadzanie poprawek do istniejącej dokumentacji



### Społeczność<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Community](http://soapconf.com/wp-content/uploads/2017/02/logo.png2)
Note: warto dodać logo np. Write The Docs i meetcontent


### Certyfikacja<!-- .element: style="font-family: 'Lato', Impact, sans-serif;" -->
![Certification](https://i1.wp.com/techwriter.pl/wp-content/uploads/2015/08/itcqf_logo_black-e1442054514270.jpg?fit=300%2C132)
Note: dostępne kursy w Polsce

![RTFM2](http://s2.quickmeme.com/img/c1/c1fa1ad064066b5c2ce7f4cfe448c742bdc1451557e3f8c15d6db50aede8758d.jpg)


![RTFM](https://pbs.twimg.com/media/Cgd7ixyXEAAaN1Z.jpg)
{'fraction_non_alphanumeric': 0.15864814501101135, 'fraction_numerical': 0.028460105031339996, 'mean_word_length': 4.978227848101266, 'pattern_counts': {'":': 0, '<': 52, '<?xml version=': 0, '>': 52, 'https://': 15, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6368894', 'n_tokens_mistral': 4432, 'n_tokens_neox': 4179, 'n_words': 899}