Tech Writer koduje
Podcast o technicznej stronie tworzenia dokumentacji w IT. Skupiamy się na tym jak Tech Writer może wpasować się w środowisko programistów zarówno pod kątem sposobu pracy jak i używanych technologii, narzędzi i rozwiązań. Staramy się też pokazać, że praca Tech Writera może być ciekawa i rozwijająca pod kątem umiejętności technicznych.
Kategorie:
Technologia
Technologia
#17 Webhelp kontra Progressive Web App
2020-05-18 09:06:36
Offline help, który sam się aktualizuje. Czy to w ogóle możliwe? Zastanawiamy się czy webhelp czasy świetności ma już za sobą i czy Progressive Web App (PWA) ma szansę zostać nowym królem helpów.
Informacje dodatkowe:
HTML Help: https://pl.wikipedia.org/wiki/HTML_Help
"About Webhelp Output" (pomoc MadCap Flare 2017r3): https://help.madcapsoftware.com/flare2017r2/Content/Output/Flare/WebHelp-Output/About-WebHelp-Output.htm
Progressive Web Application: https://en.wikipedia.org/wiki/Progressive_web_application
"Co zmieniają Progressive Web Applications? Wszystko, co musisz wiedzieć o PWA": https://www.e-point.pl/blog/co-zmieniaja-progressive-web-applications-wszystko-co-musisz-wiedziec-o-pwa
Oxygen Webhelp: https://www.oxygenxml.com/xml_editor/webhelp.html
Offline help, który sam się aktualizuje. Czy to w ogóle możliwe? Zastanawiamy się czy webhelp czasy świetności ma już za sobą i czy Progressive Web App (PWA) ma szansę zostać nowym królem helpów.
Informacje dodatkowe:
HTML Help: https://pl.wikipedia.org/wiki/HTML_Help
"About Webhelp Output" (pomoc MadCap Flare 2017r3): https://help.madcapsoftware.com/flare2017r2/Content/Output/Flare/WebHelp-Output/About-WebHelp-Output.htm
Progressive Web Application: https://en.wikipedia.org/wiki/Progressive_web_application
"Co zmieniają Progressive Web Applications? Wszystko, co musisz wiedzieć o PWA": https://www.e-point.pl/blog/co-zmieniaja-progressive-web-applications-wszystko-co-musisz-wiedziec-o-pwa
Oxygen Webhelp: https://www.oxygenxml.com/xml_editor/webhelp.html
#16 DITA z Gita
2020-04-22 12:32:11
Czy szanujący się zespół dokumentacyjny używający standardu DITA może działać bez CCMSa? Czy Technical Writer odnajdzie się w gicie? Jakie wyzwania stwarza taka implementacja? Techniczna rozmowa o technical writingu.
Informacje dodatkowe:
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system
DITA Open Toolkit: https://www.dita-ot.org/
Git: https://git-scm.com/
DITA for Small Teams: http://www.d4st.org/
Python: https://www.python.org/
IntelliJ IDEA: https://www.jetbrains.com/idea/
Poetry: https://python-poetry.org/
Gradle: https://gradle.org/
Lightweight DITA: http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf
Oxygen XML: https://www.oxygenxml.com/
Schematron: http://schematron.com/
Apache Ant: https://ant.apache.org/
Extensible Stylesheet Language Transformations (XSLT): https://pl.wikipedia.org/wiki/XSL_Transformations
Pytest: https://docs.pytest.org/en/latest/
Git submodules: https://git-scm.com/book/en/v2/Git-Tools-Submodules
Continuous integration (CI): https://en.m.wikipedia.org/wiki/Continuous_integration
TeamCity: https://www.jetbrains.com/teamcity/
npm: https://www.npmjs.com/
Docker: https://www.docker.com/
Bitbucket: https://bitbucket.org/
Progressive Web Apps: https://web.dev/what-are-pwas/
Prince XML: https://www.princexml.com/
Czy szanujący się zespół dokumentacyjny używający standardu DITA może działać bez CCMSa? Czy Technical Writer odnajdzie się w gicie? Jakie wyzwania stwarza taka implementacja? Techniczna rozmowa o technical writingu.
Informacje dodatkowe:
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system
DITA Open Toolkit: https://www.dita-ot.org/
Git: https://git-scm.com/
DITA for Small Teams: http://www.d4st.org/
Python: https://www.python.org/
IntelliJ IDEA: https://www.jetbrains.com/idea/
Poetry: https://python-poetry.org/
Gradle: https://gradle.org/
Lightweight DITA: http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf
Oxygen XML: https://www.oxygenxml.com/
Schematron: http://schematron.com/
Apache Ant: https://ant.apache.org/
Extensible Stylesheet Language Transformations (XSLT): https://pl.wikipedia.org/wiki/XSL_Transformations
Pytest: https://docs.pytest.org/en/latest/
Git submodules: https://git-scm.com/book/en/v2/Git-Tools-Submodules
Continuous integration (CI): https://en.m.wikipedia.org/wiki/Continuous_integration
TeamCity: https://www.jetbrains.com/teamcity/
Docker: https://www.docker.com/
Bitbucket: https://bitbucket.org/
Progressive Web Apps: https://web.dev/what-are-pwas/
Prince XML: https://www.princexml.com/
#15 Technoskryby potyczki z SME, czyli jak zdobywać informacje potrzebne do tworzenia dokumentacji
2020-04-07 12:19:48
Jak Technical Writer radzi sobie ze zdobywaniem informacji? Co jeśli Subject Matter Expert (SME) jest niedostępny? A co jeśli dwóch SME nie może się zgodzić co jest najważniejsze? Rozmawiamy z Mateuszem Boryckim, który przynosi cztery prawdziwe historie (case studies) z życia Technical Writera.
Jak Technical Writer radzi sobie ze zdobywaniem informacji? Co jeśli Subject Matter Expert (SME) jest niedostępny? A co jeśli dwóch SME nie może się zgodzić co jest najważniejsze? Rozmawiamy z Mateuszem Boryckim, który przynosi cztery prawdziwe historie (case studies) z życia Technical Writera.
#14 Tech Writer zaczyna kodować w Pythonie, czyli o narzędziach i dobrych praktykach
2020-03-24 13:57:11
Rozmawiamy z Sebastianem Witowskim o tym jak ustawić sobie środowisko do kodowania w Pythonie i jakich błędów unikać zaczynając swoją przygodę z tym językiem programowania. Spora dawka wiedzy dla początkujących Pythonistów. Ale jeśli kodujesz w Pythonie od jakiegoś czasu i chcesz się upewnić, że stosujesz dobre praktyki, to ten odcinek jest też dla Ciebie.
Informacje dodatkowe:
Python: https://www.python.org/
Intellij IDEA: https://www.jetbrains.com/idea/
PyCharm: https://www.jetbrains.com/pycharm/
Visual Studio Code (VS Code): https://code.visualstudio.com/
Vim: https://www.vim.org/
pyenv: https://github.com/pyenv/pyenv
Python venv: https://docs.python.org/3/library/venv.html
Python virtualenv: https://virtualenv.pypa.io/en/stable/
Conda: https://docs.conda.io/en/latest/
Node modules: https://www.w3schools.com/nodejs/nodejs_modules.asp
Pipenv: https://pipenv.readthedocs.io/en/latest/
Poetry: https://python-poetry.org/
Python Requests: https://2.python-requests.org/en/master/
Django: https://www.djangoproject.com/
Flask: https://flask.palletsprojects.com/en/1.1.x/
EuroPython 2019: https://ep2019.europython.eu/
Cookiecutter: https://cookiecutter.readthedocs.io/en/1.7.0/
Pipx: https://github.com/pipxproject/pipx
Black: https://github.com/psf/black
npm: https://www.npmjs.com/
npx: https://www.npmjs.com/package/npx
"The Hitchhiker’s Guide to Python!", Kenneth Reitz, Tanya Schlusser: https://docs.python-guide.org/
Sphinx: http://www.sphinx-doc.org/en/master/
Write the Docs: https://www.writethedocs.org/
Pytest: https://docs.pytest.org/en/latest/
Python unittest: https://docs.python.org/3.8/library/unittest.html
Test Driven Development (TDD): https://www.agilealliance.org/glossary/tdd/
Git: https://git-scm.com/
Warsztat "Modern Python Developer's Toolkit": https://www.meetup.com/Pykonik/events/268809734/
Pykonik, Kraków Python User Group: https://www.meetup.com/Pykonik/
Profil Sebastiana na LinkedIn: https://www.linkedin.com/in/switowski/
Profil Sebastiana na Twitterze: https://twitter.com/SebaWitowski
Strona Sebastiana: https://switowski.com/
Rozmawiamy z Sebastianem Witowskim o tym jak ustawić sobie środowisko do kodowania w Pythonie i jakich błędów unikać zaczynając swoją przygodę z tym językiem programowania. Spora dawka wiedzy dla początkujących Pythonistów. Ale jeśli kodujesz w Pythonie od jakiegoś czasu i chcesz się upewnić, że stosujesz dobre praktyki, to ten odcinek jest też dla Ciebie.
Informacje dodatkowe:
Python: https://www.python.org/
Intellij IDEA: https://www.jetbrains.com/idea/
PyCharm: https://www.jetbrains.com/pycharm/
Visual Studio Code (VS Code): https://code.visualstudio.com/
Vim: https://www.vim.org/
pyenv: https://github.com/pyenv/pyenv
Python venv: https://docs.python.org/3/library/venv.html
Python virtualenv: https://virtualenv.pypa.io/en/stable/
Conda: https://docs.conda.io/en/latest/
Node modules: https://www.w3schools.com/nodejs/nodejs_modules.asp
Pipenv: https://pipenv.readthedocs.io/en/latest/
Poetry: https://python-poetry.org/
Python Requests: https://2.python-requests.org/en/master/
Django: https://www.djangoproject.com/
Flask: https://flask.palletsprojects.com/en/1.1.x/
EuroPython 2019: https://ep2019.europython.eu/
Cookiecutter: https://cookiecutter.readthedocs.io/en/1.7.0/
Pipx: https://github.com/pipxproject/pipx
Black: https://github.com/psf/black
npx: https://www.npmjs.com/package/npx
"The Hitchhiker’s Guide to Python!", Kenneth Reitz, Tanya Schlusser: https://docs.python-guide.org/
Sphinx: http://www.sphinx-doc.org/en/master/
Write the Docs: https://www.writethedocs.org/
Pytest: https://docs.pytest.org/en/latest/
Python unittest: https://docs.python.org/3.8/library/unittest.html
Test Driven Development (TDD): https://www.agilealliance.org/glossary/tdd/
Git: https://git-scm.com/
Warsztat "Modern Python Developer's Toolkit": https://www.meetup.com/Pykonik/events/268809734/
Pykonik, Kraków Python User Group: https://www.meetup.com/Pykonik/
Profil Sebastiana na LinkedIn: https://www.linkedin.com/in/switowski/
Profil Sebastiana na Twitterze: https://twitter.com/SebaWitowski
Strona Sebastiana: https://switowski.com/
#13 Full-Stack Tech Writer, czyli technoskryba kontra chmura
2020-02-25 14:25:48
Jakie są obowiązki Technical Writera? Pewnie większość z Was odpowiedziałaby, że pisanie dokumentacji. A co z budowaniem stron i hostowaniem ich w chmurze? Damy sobie z tym radę? Ten odcinek to nie rozważania teoretyczne, ale oparta na faktach historia o tym jak trzech Technical Writerów ogarnęło cały stack technologiczny i devops dla portalu z dokumentacją.
Informacje dodatkowe:
Konferencja soap!: http://soapconf.com/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Markdown: https://daringfireball.net/projects/markdown/
DITA Open Toolkit: https://www.dita-ot.org/
Component content management system (CCMS): https://en.wikipedia.org/wiki/Component_content_management_system
Node.js: https://nodejs.org/en/
Python: https://www.python.org/
Scrapy: https://scrapy.org/
Jinja2: https://jinja.palletsprojects.com/en/2.11.x/
Sphinx: http://www.sphinx-doc.org/en/master/
Elasticsearch: https://www.elastic.co/
Kubernetes: https://kubernetes.io/
Jakie są obowiązki Technical Writera? Pewnie większość z Was odpowiedziałaby, że pisanie dokumentacji. A co z budowaniem stron i hostowaniem ich w chmurze? Damy sobie z tym radę? Ten odcinek to nie rozważania teoretyczne, ale oparta na faktach historia o tym jak trzech Technical Writerów ogarnęło cały stack technologiczny i devops dla portalu z dokumentacją.
Informacje dodatkowe:
Konferencja soap!: http://soapconf.com/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Markdown: https://daringfireball.net/projects/markdown/
DITA Open Toolkit: https://www.dita-ot.org/
Component content management system (CCMS): https://en.wikipedia.org/wiki/Component_content_management_system
Node.js: https://nodejs.org/en/
Python: https://www.python.org/
Scrapy: https://scrapy.org/
Jinja2: https://jinja.palletsprojects.com/en/2.11.x/
Sphinx: http://www.sphinx-doc.org/en/master/
Elasticsearch: https://www.elastic.co/
Kubernetes: https://kubernetes.io/
#12 Tech Writer się rekrutuje, czyli jak ważne są umiejętności techniczne
2020-01-20 16:48:13
Czy ogłoszenie o pracę mówi Ci co będziesz robił jako Technical Writer? Jak pracodawca sprawdzi Twoje umiejętności? Co się liczy u Technical Writera? Rozmawiamy z Tomkiem Prusem o blaskach i cieniach rekrutowania Technical Writerów starając się odpowiedzieć na pytanie jak ważne w naszej profesji są umiejętności techniczne.
Czy ogłoszenie o pracę mówi Ci co będziesz robił jako Technical Writer? Jak pracodawca sprawdzi Twoje umiejętności? Co się liczy u Technical Writera? Rozmawiamy z Tomkiem Prusem o blaskach i cieniach rekrutowania Technical Writerów starając się odpowiedzieć na pytanie jak ważne w naszej profesji są umiejętności techniczne.
#11 Robot dokumentuje część 2 - automatyzacja kontra ludzie
2019-12-12 20:02:21
Spotkaliśmy się z Agatą Rygielską i rozmawialiśmy o wpływie automatyzacji na ludzi i ich pracę. Agata jest Technical Writerką od 2 lat, a wcześniej pracowała w branży tłumaczeniowej. Widziała jak automatyzacja doprowadziła do marginalizacji "białkowych" tłumaczy. Jej doświadczenia doprowadziły nas do rozważań o przyszłości komunikacji technicznej. Czy przyszłość rysuje się optymistycznie dla Technical Writerów, czy raczej w ciemnych barwach?
Informacje dodatkowe:
DeepL: https://www.deepl.com/translator
MadCap Software: https://www.madcapsoftware.com/
Konferencja Tłumaczy: https://www.konferencjatlumaczy.pl/
Spotkaliśmy się z Agatą Rygielską i rozmawialiśmy o wpływie automatyzacji na ludzi i ich pracę. Agata jest Technical Writerką od 2 lat, a wcześniej pracowała w branży tłumaczeniowej. Widziała jak automatyzacja doprowadziła do marginalizacji "białkowych" tłumaczy. Jej doświadczenia doprowadziły nas do rozważań o przyszłości komunikacji technicznej. Czy przyszłość rysuje się optymistycznie dla Technical Writerów, czy raczej w ciemnych barwach?
Informacje dodatkowe:
DeepL: https://www.deepl.com/translator
MadCap Software: https://www.madcapsoftware.com/
Konferencja Tłumaczy: https://www.konferencjatlumaczy.pl/
#10 Docusaurus - Tech Writer dokarmia dinozaury
2019-11-15 12:45:30
Docusaurus to static site generator stworzony przez Facebooka, którego główną zaletą jest prostota. Rozmawiamy o tym co oferuje to narzędzie, jakie są jego mocne i słabe strony oraz w jakich sytuacjach może się sprawdzić jako rozwiązanie do tworzenia dokumentacji.
Informacje dodatkowe:
Docusaurus: https://docusaurus.io/
Using Docusaurus to Create Open Source Websites: https://www.youtube.com/watch?v=QcGJsf6mgZE
React: https://pl.reactjs.org/
Crowdin: https://crowdin.com/
StaticGen: https://www.staticgen.com/
I'd Rather Be Writing: https://idratherbewriting.com/
Tech Writer koduje: https://techwriterkoduje.pl/
Docusaurus to static site generator stworzony przez Facebooka, którego główną zaletą jest prostota. Rozmawiamy o tym co oferuje to narzędzie, jakie są jego mocne i słabe strony oraz w jakich sytuacjach może się sprawdzić jako rozwiązanie do tworzenia dokumentacji.
Informacje dodatkowe:
Docusaurus: https://docusaurus.io/
Using Docusaurus to Create Open Source Websites: https://www.youtube.com/watch?v=QcGJsf6mgZE
React: https://pl.reactjs.org/
Crowdin: https://crowdin.com/
StaticGen: https://www.staticgen.com/
I'd Rather Be Writing: https://idratherbewriting.com/
Tech Writer koduje: https://techwriterkoduje.pl/
#9 Robot dokumentuje, czyli technical writing przyszłości
2019-10-17 18:34:12
Podobno nikt nie jest niezastąpiony, ale czy można zastąpić całą grupę zawodową? Zwłaszcza ludzi, którzy robią research, rozmawiają z innymi i piszą? O automatyzacji w technical writingu rozmawia z nami Wojtek Aleksander.
Informacje dodatkowe:
"The Future of Employment: How susceptible are jobs to computerisation?", Oxford Martin: https://www.oxfordmartin.ox.ac.uk/publications/the-future-of-employment/
"10 skills you'll need to survive the rise of automation", World Economic Forum: https://www.weforum.org/agenda/2018/07/the-skills-needed-to-survive-the-robot-invasion-of-the-workplace
"JPMorgan Chase inks 5-year deal to generate marketing copy via AI", Marketing Dive: https://www.marketingdive.com/news/jpmorgan-chase-inks-5-year-deal-to-generate-marketing-copy-via-ai/559836/
Horse ebooks (Twitter bot): https://twitter.com/horse_ebooks
Bot or not: http://botpoet.com/
"Can science writing be automated?", MIT News: http://news.mit.edu/2019/can-science-writing-be-automated-ai-0418
"Lithium-Ion Batteries. A Machine-Generated Summary of Current Research", Springer: https://link.springer.com/book/10.1007/978-3-030-16800-1
"The Rise of the Robot Reporter", New York Times: https://www.nytimes.com/2019/02/05/business/media/artificial-intelligence-journalism-robots.html
Konferencja Tłumaczy: https://www.konferencjatlumaczy.pl/
Wojtek Aleksander (profil LinkedIn): https://www.linkedin.com/in/waleksander/
Podobno nikt nie jest niezastąpiony, ale czy można zastąpić całą grupę zawodową? Zwłaszcza ludzi, którzy robią research, rozmawiają z innymi i piszą? O automatyzacji w technical writingu rozmawia z nami Wojtek Aleksander.
Informacje dodatkowe:
"The Future of Employment: How susceptible are jobs to computerisation?", Oxford Martin: https://www.oxfordmartin.ox.ac.uk/publications/the-future-of-employment/
"10 skills you'll need to survive the rise of automation", World Economic Forum: https://www.weforum.org/agenda/2018/07/the-skills-needed-to-survive-the-robot-invasion-of-the-workplace
"JPMorgan Chase inks 5-year deal to generate marketing copy via AI", Marketing Dive: https://www.marketingdive.com/news/jpmorgan-chase-inks-5-year-deal-to-generate-marketing-copy-via-ai/559836/
Horse ebooks (Twitter bot): https://twitter.com/horse_ebooks
Bot or not: http://botpoet.com/
"Can science writing be automated?", MIT News: http://news.mit.edu/2019/can-science-writing-be-automated-ai-0418
"Lithium-Ion Batteries. A Machine-Generated Summary of Current Research", Springer: https://link.springer.com/book/10.1007/978-3-030-16800-1
"The Rise of the Robot Reporter", New York Times: https://www.nytimes.com/2019/02/05/business/media/artificial-intelligence-journalism-robots.html
Konferencja Tłumaczy: https://www.konferencjatlumaczy.pl/
Wojtek Aleksander (profil LinkedIn): https://www.linkedin.com/in/waleksander/
#8 DITA OT - static site generator dla wtajemniczonych
2019-09-28 22:16:10
Jako technoskrybi, którzy kodują, spędziliśmy trochę czasu z DITA Open Toolkit. Rozmawiamy o tym do czego służy DITA OT i jakie ma możliwości. Mówimy o wadach i zaletach. Podpowiadamy też jak zacząć pracę z tym narzędziem. Pracujesz z ditą lub chcesz dowiedzieć się o niej więcej? To jest odcinek dla Ciebie.
Informacje dodatkowe:
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Konsorcjum OASIS: https://www.oasis-open.org/
DITA Open Toolkit: https://www.dita-ot.org/
Lightweight DITA: http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf
Extensible Stylesheet Language Transformations (XSLT): https://pl.wikipedia.org/wiki/XSL_Transformations
XSL Formatting Objects (FO): https://pl.wikipedia.org/wiki/XSL_Formatting_Objects
Syncro Soft: http://www.sync.ro/
Oxygen XML: https://www.oxygenxml.com/
Oxygen Webhelp: https://www.oxygenxml.com/xml_editor/webhelp.html
easyDITA: https://easydita.com/
Schematron: http://schematron.com/
Apache Ant: https://ant.apache.org/
Wtyczka Gradle dla DITA OT: https://eerohele.github.io/dita-ot-gradle/
Adobe Experience Manager: https://www.adobe.com/pl/marketing/experience-manager.html
Markdown: https://daringfireball.net/projects/markdown/syntax
reStructuredText: http://docutils.sourceforge.net/rst.html
AsciiDoc: http://asciidoc.org/
Sphinx: http://www.sphinx-doc.org/en/master/
StaticGen: https://www.staticgen.com/
Jako technoskrybi, którzy kodują, spędziliśmy trochę czasu z DITA Open Toolkit. Rozmawiamy o tym do czego służy DITA OT i jakie ma możliwości. Mówimy o wadach i zaletach. Podpowiadamy też jak zacząć pracę z tym narzędziem. Pracujesz z ditą lub chcesz dowiedzieć się o niej więcej? To jest odcinek dla Ciebie.
Informacje dodatkowe:
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Konsorcjum OASIS: https://www.oasis-open.org/
DITA Open Toolkit: https://www.dita-ot.org/
Lightweight DITA: http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf
Extensible Stylesheet Language Transformations (XSLT): https://pl.wikipedia.org/wiki/XSL_Transformations
XSL Formatting Objects (FO): https://pl.wikipedia.org/wiki/XSL_Formatting_Objects
Syncro Soft: http://www.sync.ro/
Oxygen XML: https://www.oxygenxml.com/
Oxygen Webhelp: https://www.oxygenxml.com/xml_editor/webhelp.html
easyDITA: https://easydita.com/
Schematron: http://schematron.com/
Apache Ant: https://ant.apache.org/
Wtyczka Gradle dla DITA OT: https://eerohele.github.io/dita-ot-gradle/
Adobe Experience Manager: https://www.adobe.com/pl/marketing/experience-manager.html
Markdown: https://daringfireball.net/projects/markdown/syntax
reStructuredText: http://docutils.sourceforge.net/rst.html
AsciiDoc: http://asciidoc.org/
Sphinx: http://www.sphinx-doc.org/en/master/
StaticGen: https://www.staticgen.com/