ENGLISH

Workshop výměny zkušeností mezi techwritery 2019

TW Workshop sdružuje nadšené techwritery z České republiky, aby sdíleli své znalosti, zkušenosti a v neposlední řadě i radost z psaní. Chcete-li se setkat s (nejen) českými techwritery, najít řešení nějaké zapeklitosti týkající se textu nebo třeba nástrojů nebo naopak prezentovat výsledky vaší práce či nový způsob práce, pak jste v naší skupině vřele vítáni. Stejně jako my možná rádi uvidíte, že všichni více méně bojujeme se stejnou hydrou. Nebo možná větrnými mlýny.

Naše setkání se konalo 13. června 2019 v Praze. Jaké prezentace jsme viděli?

Mailinglist

Pokud chcete být informováni, jakmile začneme plánovat nový ročník, a o dalších novinkách, přihlaste se do našeho mailinglistu: https://lists.nic.cz/mailman/listinfo/tww. Naše oznámení na mailinglistu uchováváme na nezbytném minimu a současně je to nejjednodušší způsob, jak se dozvědět o konání workshopu. Samozřejmě každý může do mailinglistu přispívat.

Výzva k prezentacím

Rádi bychom Vás vyzvali k přípravě prezentace. Staňte se na našem workshopu přednášejícími!

Téma pro letošní rok by se mělo odehrávat v duchu učení těch nejmladších v oboru. To znamená, že bych Vás chtěla letos poprosit o přípravu prezentací pro začínající techwritery ze všech možných úhlů, které náš obor nabízí (myšleno je obojí, teorie i praxe). Téma je samozřejmě nepovinné a my s radostí zvážíme jakýkoliv návrh na prezentaci.

Co je také důležité dodat, jedna osoba může navrhnout více témat k prezentaci, pokud si to přeje.

Výzva pro tento ročník byla uzavřena.

Následuje již tradiční seznam oblastí témat, které Vám mohou pomoci najít inspiraci:

  • Techniky psaní v technické komunikaci
  • Nástroje a publikační systémy
  • Jazyk a překlady
  • Vedení TW/TC týmu
  • Prosazování TW/TC týmu uvnitř vaší společnosti
  • Prosazování/marketing TC profese obecně
  • Technologické nebo metodologické inovace
  • Učení TC / příležitosti ke vzdělávání se v oblasti TW/TC

Přibližný program

  • Příchod od 9:30,
  • přivítání/networking,
  • hlavní program začne v 10:00,
    • formát: prezentace (viz níže) + Q&A
  • pauza na oběd někde uprostřed,
  • pracovní skupina (představení),
  • konec kolem 17:00

Prezentace proložíme pauzami s kávou a lehkou svačinkou.

Kapacita

Kapacita workshopu je 20 účastníků včetně prezentujících.

Jazyk

Náš workshop nenavštěvují jen češi, proto jsme se rozhodli, že akce bude probíhat v obou jazycích – prezentující se rozhodnou sami, ve kterém jazyce chtějí mluvit (čeština nebo angličtina).

Doporučeným jazykem pro workshop je angličtina.

Registrace

Workshop již proběhl.

Prezentace

  • Robert Krátký (Red Hat): Documentation as Code: Making Writing “Technical” Again (40 min)
    Forget about Word or RoboHelp - docs can be developed, published, and maintained using a plain-text editor and a version-control system, such as Git(Hub). What advantages and challenges does it bring?
    Attendees can expect to be introduced to basic principles of an approach towards authoring and delivering docs that utilizes processes usually associated with SW development: distributed version-control systems (Git) and CI/CD for implementing automated testing and collaboration with other writers.
    SLIDES

  • Tomáš Došek (CS Soft): Measure Twice: How to Improve Proofreading in Technical Documentation (20 min)
    Since proofreading is our last chance to influence the text, in my talk, I would like to focus on this part of the documentation process. I will clarify what is essential for an efficient proofreading process and how to do it properly.
    I would like to point out that only a small systematic change in our approach to reviewing a text can have a significant impact on the quality of it. Based on the analysis of some typical errors at the morphological, syntactical and contextual levels, I will demonstrate how to make proofreading more accurate and reliable.
    SLIDES

  • Jaromír Hradílek (Red Hat): Evolution of RHEL 8 documentation (30 min)
    On May 7, 2019, Red Hat released Red Hat Enterprise Linux 8. The comprehensive documentation for this release was in development for over a year and the team working on it decided to change pretty much everything, from the markup language to the way how the documentation is written and stored in the repository. As this is the first major release that fully embraces the principles of modular documentation written in AsciiDoc, let's talk about what exactly we changed, why, and what we learned in the process.
    SLIDES

  • Zuzana Lena Ansorgová (CZ.NIC): Standards & Best Practices (20 min)
    To become a good techwriter and develop high-quality documentation, you don't have to reinvent the wheel. Let us look at the current resources of documentation mastery.
    SLIDES

  • Vendula Ferschmannová (Red Hat): Promoting documentation in your company (20 min)
    I'd like to talk a bit about visibility inside your company and tools you can use to improve it. I'm also very curious about your tips and tricks on how to deal with the problem of visibility and social status of technical writers. So, let's share ideas about building our own brand.
    SLIDES

  • Kristián Klíma (GoodData): Confluenced (20 min)
    At GoodData, we develop our customer-facing documentation in Confluence. I’d like to talk about how and why we’re using the Confluence ecosystem, especially deploying K15t’s add-ons such as Scroll Versions, Scroll Translations and Scroll Viewport.
    Outline: 1. Advantages - WYSIWYG CMS system, flexibility, ecosystem, support; 2. Maintenance/Support arrangements; 3. Getting around licence limitations; 4. Workflow, scheduling, publishing; 5. Handling localizations; 6. Visuals appearance, GUI - CSS vs Viewport; 7. Hacks (reverse publishing, edit HTML without HTML with Source Editor disabled...)
    SLIDES

  • Filip Hanzelka (Red Hat): Look! I Have Come Through! My Transitioning to Technical Writing (20 min)
    In this talk, I would like to talk about my experience of transitioning from being a university lecturer to being a technical writer. I would like to point out what was particularly difficult for me and what I have learned on the way. I will touch upon the rights and responsibilities of a technical writer and the other stakeholders s/he interacts with, and on the general differences between a corporate and university environment as I have perceived them.
    SLIDES

  • Marie Doleželová (Red Hat): Writing documentation based on customer needs (10 min)
    Technical writers are usually not in everyday face-to-face contact with customers. However, to produce quality documentation, it is necessary to receive feedback from customers, which is normally ensured by various tools at Red Hat. For me personally, it is also very important to feel that my work is connected with real people's needs. A few months ago, I had a chance to participate in a project focused on cooperation of technical writers with customer-facing professions, such as consultants, in order to gather topics for new user stories based on everyday use cases. I would like to share my experience from this project, and I would also like to discuss the approaches used in your companies to learn which documentation customers really need.
    SLIDES - The presentation was without slides.

Přechozí ročníky

© 2019 CZ.NIC, z. s. p. o.