Technical Writers' Exchange of Experience Workshop

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.

Více informací najdete na stránce workshopu.

Prezentace

Prezentace doposud přihlášené na letošní ročník (pořadí není konečné):

  • 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.

  • 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.

  • 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.

  • Zuzana Lena Ansorgova (CZ.NIC): Standards & Best Practices
    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 documentarian mastery.

  • Vendula Ferschmannova (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.

  • Kristian Klima, Vendula Lucakova (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...); 8. Q&A

Rozvrh

Datum Čas Místo Lektor Volná místa Cena s DPH Přihlásit