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
#37 Tech Writer potrzebuje więcej dynamiki, czyli zbyt statyczne strony z dokumentacją
2021-12-06 11:11:40
Dostarczanie statycznych stron z dokumentacją ostatnimi czasy wraca do łask. Prawdopodobnie dlatego, że takie strony są szybkie, bezpieczne i łatwe w serwowaniu. Jednak w niektórych sytuacjach mogą nas też ograniczać i sprawiać, że aktualizowanie ich zawartości staje się czasochłonne i problematyczne. Rozmawiamy o tym kiedy strony stają się zbyt statyczne i jak można temu zaradzić.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Strona statyczna (static site): https://slownik.intensys.pl/definicja/strona-statyczna/
Serwer aplikacji: https://pl.wikipedia.org/wiki/Serwer_aplikacji
Aplikacja internetowa/webowa: https://pl.wikipedia.org/wiki/Aplikacja_internetowa
DITA Open Toolkit: https://www.dita-ot.org/
Docusaurus: https://docusaurus.io/
Hugo: https://gohugo.io/
Gatsby: https://www.gatsbyjs.com/
Continuous Integration (CI)/Continuous Deployment (CD): https://en.wikipedia.org/wiki/CI/CD
"Git Branch": https://www.atlassian.com/git/tutorials/using-branches
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Markdown: https://daringfireball.net/projects/markdown/syntax
Adobe FrameMaker: https://en.wikipedia.org/wiki/Adobe_FrameMaker
Oxygen XML Webhelp Responsive: https://www.oxygenxml.com/doc/versions/24.0/ug-webhelp-responsive/
Next.js: https://nextjs.org/
Node.js: https://nodejs.org/en/
Express.js: https://expressjs.com/
WordPress: https://wordpress.com/
Dostarczanie statycznych stron z dokumentacją ostatnimi czasy wraca do łask. Prawdopodobnie dlatego, że takie strony są szybkie, bezpieczne i łatwe w serwowaniu. Jednak w niektórych sytuacjach mogą nas też ograniczać i sprawiać, że aktualizowanie ich zawartości staje się czasochłonne i problematyczne. Rozmawiamy o tym kiedy strony stają się zbyt statyczne i jak można temu zaradzić.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Strona statyczna (static site): https://slownik.intensys.pl/definicja/strona-statyczna/
Serwer aplikacji: https://pl.wikipedia.org/wiki/Serwer_aplikacji
Aplikacja internetowa/webowa: https://pl.wikipedia.org/wiki/Aplikacja_internetowa
DITA Open Toolkit: https://www.dita-ot.org/
Docusaurus: https://docusaurus.io/
Hugo: https://gohugo.io/
Gatsby: https://www.gatsbyjs.com/
Continuous Integration (CI)/Continuous Deployment (CD): https://en.wikipedia.org/wiki/CI/CD
"Git Branch": https://www.atlassian.com/git/tutorials/using-branches
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Markdown: https://daringfireball.net/projects/markdown/syntax
Adobe FrameMaker: https://en.wikipedia.org/wiki/Adobe_FrameMaker
Oxygen XML Webhelp Responsive: https://www.oxygenxml.com/doc/versions/24.0/ug-webhelp-responsive/
Next.js: https://nextjs.org/
Node.js: https://nodejs.org/en/
Express.js: https://expressjs.com/
WordPress: https://wordpress.com/
#36 Tech Writer się boi, czyli Halloween Special 2021
2021-10-31 08:15:52
Wszyscy czegoś się boją. Zdarza się, że nawiedzają nas koszmary i zjawy z przeszłości. Tech Writerzy nie są pod tym względem wyjątkiem. Mają swoje, nierzadko osobliwe, strachy. Z okazji Halloween rozmawiamy o tym czego boi się technoskryba i co nie daje mu spać po nocach.
Uwaga: odcinek tylko dla ludzi o mocnych nerwach!
Informacje dodatkowe:
Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji
Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
"Clippy": https://en.wikipedia.org/wiki/Office_Assistant
Subversion (SVN): https://subversion.apache.org/
Git: https://git-scm.com/
"Using Branches": https://svnbook.red-bean.com/en/1.7/svn.branchmerge.using.html
Gif "Git merge": https://gifer.com/en/7h7L
Git Cherry Pick: https://www.atlassian.com/git/tutorials/cherry-pick
Sphinx: https://www.sphinx-doc.org/en/master/
Jamstack: https://jamstack.org/
Python: https://www.python.org/
"What is a Static Site Generator? And 3 ways to find the best one": https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/
"Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/
"Rethink your screenshots and tutorials with a SUI", Anton Bollen: https://www.youtube.com/watch?v=hbT5U63uKkg
Micromanagement: https://en.wikipedia.org/wiki/Micromanagement
Film "Kingsajz": https://pl.wikipedia.org/wiki/Kingsajz
"Writing is like sorting laundry -- practical advice for tackling documentation projects": https://idratherbewriting.com/2015/01/29/writing-is-like-sorting-laundry-practical-advice-for-tackling-documentation-projects/
Podręcznik stylu (style guide): http://techwriter.pl/podrecznik-stylu-stylrecznik/
TeamCity: https://www.jetbrains.com/teamcity/
Docker: https://www.docker.com/
bash: https://pl.wikipedia.org/wiki/Bash
Syndrom oszusta: https://pl.wikipedia.org/wiki/Syndrom_oszusta
OpenID Connect: https://openid.net/connect/
OAuth 2.0: https://oauth.net/2/
JWT (JSON Web Tokens): https://jwt.io/
Serial comma/Oxford comma: https://en.wikipedia.org/wiki/Serial_comma
Stack Overflow: https://stackoverflow.com/
"The One Where Ross Got High", Friends: https://en.wikipedia.org/wiki/The_One_Where_Ross_Got_High
Wszyscy czegoś się boją. Zdarza się, że nawiedzają nas koszmary i zjawy z przeszłości. Tech Writerzy nie są pod tym względem wyjątkiem. Mają swoje, nierzadko osobliwe, strachy. Z okazji Halloween rozmawiamy o tym czego boi się technoskryba i co nie daje mu spać po nocach.
Uwaga: odcinek tylko dla ludzi o mocnych nerwach!
Informacje dodatkowe:
Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji
Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
"Clippy": https://en.wikipedia.org/wiki/Office_Assistant
Subversion (SVN): https://subversion.apache.org/
Git: https://git-scm.com/
"Using Branches": https://svnbook.red-bean.com/en/1.7/svn.branchmerge.using.html
Gif "Git merge": https://gifer.com/en/7h7L
Git Cherry Pick: https://www.atlassian.com/git/tutorials/cherry-pick
Sphinx: https://www.sphinx-doc.org/en/master/
Jamstack: https://jamstack.org/
Python: https://www.python.org/
"What is a Static Site Generator? And 3 ways to find the best one": https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/
"Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/
"Rethink your screenshots and tutorials with a SUI", Anton Bollen: https://www.youtube.com/watch?v=hbT5U63uKkg
Micromanagement: https://en.wikipedia.org/wiki/Micromanagement
Film "Kingsajz": https://pl.wikipedia.org/wiki/Kingsajz
"Writing is like sorting laundry -- practical advice for tackling documentation projects": https://idratherbewriting.com/2015/01/29/writing-is-like-sorting-laundry-practical-advice-for-tackling-documentation-projects/
Podręcznik stylu (style guide): http://techwriter.pl/podrecznik-stylu-stylrecznik/
TeamCity: https://www.jetbrains.com/teamcity/
Docker: https://www.docker.com/
bash: https://pl.wikipedia.org/wiki/Bash
Syndrom oszusta: https://pl.wikipedia.org/wiki/Syndrom_oszusta
OpenID Connect: https://openid.net/connect/
OAuth 2.0: https://oauth.net/2/
JWT (JSON Web Tokens): https://jwt.io/
Serial comma/Oxford comma: https://en.wikipedia.org/wiki/Serial_comma
Stack Overflow: https://stackoverflow.com/
"The One Where Ross Got High", Friends: https://en.wikipedia.org/wiki/The_One_Where_Ross_Got_High
#35 Tech Writer chce kodować więcej
2021-10-26 09:41:43
Czy Tech Writer, który trochę koduje może kodować więcej? Jakie ma opcje rozwoju zawodowego jeśli interesują go głównie skrypty, narzędzia i inne techniczne aspekty tworzenia dokumentacji?
Bazując na własnych doświadczeniach, rozważamy trzy możliwe scenariusze dla technoskrybów z zapędami programistycznymi. Pojawia się też kilka czerstwych żartów i nawiązań do zamierzchłych czasów.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Python: https://www.python.org/
MadCap Flare: https://www.madcapsoftware.com/products/flare/
Visual Basic for Applications:
Perl: https://www.perl.org/
Arbortext: https://www.ptc.com/en/products/arbortext
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
DITA Open Toolkit: https://www.dita-ot.org/
Front-end i back-end: https://pl.wikipedia.org/wiki/Front-end_i_back-end
gulp.js: https://gulpjs.com/
React: https://pl.reactjs.org/
Svelte: https://svelte.dev/
Teleturniej "Idź na całość": https://pl.wikipedia.org/wiki/Id%C5%BA_na_ca%C5%82o%C5%9B%C4%87
Telegazeta: https://pl.wikipedia.org/wiki/Telegazeta
Czy Tech Writer, który trochę koduje może kodować więcej? Jakie ma opcje rozwoju zawodowego jeśli interesują go głównie skrypty, narzędzia i inne techniczne aspekty tworzenia dokumentacji?
Bazując na własnych doświadczeniach, rozważamy trzy możliwe scenariusze dla technoskrybów z zapędami programistycznymi. Pojawia się też kilka czerstwych żartów i nawiązań do zamierzchłych czasów.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Python: https://www.python.org/
MadCap Flare: https://www.madcapsoftware.com/products/flare/
Visual Basic for Applications:
Perl: https://www.perl.org/
Arbortext: https://www.ptc.com/en/products/arbortext
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
DITA Open Toolkit: https://www.dita-ot.org/
Front-end i back-end: https://pl.wikipedia.org/wiki/Front-end_i_back-end
gulp.js: https://gulpjs.com/
React: https://pl.reactjs.org/
Svelte: https://svelte.dev/
Teleturniej "Idź na całość": https://pl.wikipedia.org/wiki/Id%C5%BA_na_ca%C5%82o%C5%9B%C4%87
Telegazeta: https://pl.wikipedia.org/wiki/Telegazeta
#34 Tech Writer dokumentuje, testuje, koduje, lokalizuje i projektuje, czyli człowiek renesansu w dokumentacji
2021-09-07 19:52:16
Czym na co dzień zajmuje się Technical Writer? A może lepiej zapytać czym się nie zajmuje?
Patrycja Pyrek studiuje informatykę i ekonometrię, uczy języka japońskiego i jednocześnie jako stażystka zdobywa techwriterskie doświadczenie. Ta różnorodność zainteresowań przejawia się również podczas jej stażu. Patrycja, poza tworzeniem dokumentacji, ma jeszcze szereg innych zadań, które pozwalają jej się rozwijać w obszarach testowania, lokalizacji i projektowania. Zresztą posłuchajcie sami!
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/
Protractor: https://www.protractortest.org/
AngularJS: https://angularjs.org/
OpenAPI: https://www.openapis.org/
Czym na co dzień zajmuje się Technical Writer? A może lepiej zapytać czym się nie zajmuje?
Patrycja Pyrek studiuje informatykę i ekonometrię, uczy języka japońskiego i jednocześnie jako stażystka zdobywa techwriterskie doświadczenie. Ta różnorodność zainteresowań przejawia się również podczas jej stażu. Patrycja, poza tworzeniem dokumentacji, ma jeszcze szereg innych zadań, które pozwalają jej się rozwijać w obszarach testowania, lokalizacji i projektowania. Zresztą posłuchajcie sami!
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/
Protractor: https://www.protractortest.org/
AngularJS: https://angularjs.org/
OpenAPI: https://www.openapis.org/
#33 Kodować każdy może, czyli o Akademii Motorola Solutions słów kilka
2021-08-18 09:43:54
Czy w kilka miesięcy można nauczyć się kodowania i zostać zatrudnionym jako młodszy programista w międzynarodowej korporacji? Dzięki Akademii Motorola Solutions taki scenariusz jest możliwy. Na początku sierpnia 2021 wystartowała druga edycja tego programu szkoleniowego stworzonego dla osób, które marzą o zmianie kariery i wejściu do świata IT. W tym odcinku rozmawiamy z Jackiem Drabikiem, prezesem Motorola Solutions w Polsce, oraz Klaudią Rydzanicz i Pawłem Kózką, uczestnikami pierwszej edycji Akademii, m.in. o tym kto może wziąć udział w programie oraz jak wygląda rekrutacja i proces przygotowania do nowego zawodu.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
O Akademii: https://pracawmotoroli.pl/o-akademii/
Czy w kilka miesięcy można nauczyć się kodowania i zostać zatrudnionym jako młodszy programista w międzynarodowej korporacji? Dzięki Akademii Motorola Solutions taki scenariusz jest możliwy. Na początku sierpnia 2021 wystartowała druga edycja tego programu szkoleniowego stworzonego dla osób, które marzą o zmianie kariery i wejściu do świata IT. W tym odcinku rozmawiamy z Jackiem Drabikiem, prezesem Motorola Solutions w Polsce, oraz Klaudią Rydzanicz i Pawłem Kózką, uczestnikami pierwszej edycji Akademii, m.in. o tym kto może wziąć udział w programie oraz jak wygląda rekrutacja i proces przygotowania do nowego zawodu.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
O Akademii: https://pracawmotoroli.pl/o-akademii/
#32 Tech Writer zatrudnia asystenta, czyli sztuczna inteligencja w służbie dokumentacji
2021-07-29 11:29:59
Od dawna mówi się o tym, że maszyny zastąpią ludzi i zajmą ich miejsce jako korona stworzenia. Jednak zanim to nastąpi, możemy wykorzystać sztuczną inteligencję do własnych celów. Przyglądamy się obecnie dostępnym modelom językowym, a szczególnie GPT-3, rozmawiamy o tym co potrafią i rozważamy jak można by je wykorzystać w tworzeniu dokumentacji technicznej.
Czy kodujący Tech Writer może zrobić ze sztucznej inteligencji swojego asystenta? Co mógłby robić taki asystent? Co jest najbardziej wartościowe w pracy Tech Writera, a które obowiązki warto cedować na algorytmy? Jak praktycznie się za to zabrać?
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Sztuczna inteligencja: https://pl.wikipedia.org/wiki/Sztuczna_inteligencja
Generative Pre-trained Transformer 3 (GPT-3): https://en.wikipedia.org/wiki/GPT-3
OpenAI: https://openai.com/
"#9 Robot dokumentuje, czyli technical writing przyszłości": https://techwriterkoduje.pl/blog/2019/10/17/robot-dokumentuje
"#11 Robot dokumentuje część 2 - automatyzacja kontra ludzie": https://techwriterkoduje.pl/blog/2019/12/12/robot-dokumentuje-czesc-2
Layout generator: https://twitter.com/sharifshameem/status/1282676454690451457?s=20
Natural Language Shell: https://beta.openai.com/?app=productivity&example=4_2_0
Summarization: https://beta.openai.com/?app=content-consumption&example=5_2_0
Semantic search: https://beta.openai.com/?example=0_2_0
GitHub Copilot: https://copilot.github.com/
"Copilot writes a text-based game in Python": https://sandyuraz.com/blogs/copilot-game/
Pamięć tłumaczeniowa: https://pl.wikipedia.org/wiki/Pami%C4%99%C4%87_t%C5%82umaczeniowa
"Dear Mr. Robot", Marta Bartnicka & Wojciech Froelich (soap! 2018): https://www.youtube.com/watch?v=Q_if0yBogUQ
Techwriter.pl: http://techwriter.pl/
"Going from A to C, a Practical Approach to Semantic Search", Paweł Kowaluk: https://www.slideshare.net/PawelKowaluk/semantic-search-40766546
Repozytorium GPT-2 na GitHub: https://github.com/openai/gpt-2
Od dawna mówi się o tym, że maszyny zastąpią ludzi i zajmą ich miejsce jako korona stworzenia. Jednak zanim to nastąpi, możemy wykorzystać sztuczną inteligencję do własnych celów. Przyglądamy się obecnie dostępnym modelom językowym, a szczególnie GPT-3, rozmawiamy o tym co potrafią i rozważamy jak można by je wykorzystać w tworzeniu dokumentacji technicznej.
Czy kodujący Tech Writer może zrobić ze sztucznej inteligencji swojego asystenta? Co mógłby robić taki asystent? Co jest najbardziej wartościowe w pracy Tech Writera, a które obowiązki warto cedować na algorytmy? Jak praktycznie się za to zabrać?
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Sztuczna inteligencja: https://pl.wikipedia.org/wiki/Sztuczna_inteligencja
Generative Pre-trained Transformer 3 (GPT-3): https://en.wikipedia.org/wiki/GPT-3
OpenAI: https://openai.com/
"#9 Robot dokumentuje, czyli technical writing przyszłości": https://techwriterkoduje.pl/blog/2019/10/17/robot-dokumentuje
"#11 Robot dokumentuje część 2 - automatyzacja kontra ludzie": https://techwriterkoduje.pl/blog/2019/12/12/robot-dokumentuje-czesc-2
Layout generator: https://twitter.com/sharifshameem/status/1282676454690451457?s=20
Natural Language Shell: https://beta.openai.com/?app=productivity&example=4_2_0
Summarization: https://beta.openai.com/?app=content-consumption&example=5_2_0
Semantic search: https://beta.openai.com/?example=0_2_0
GitHub Copilot: https://copilot.github.com/
"Copilot writes a text-based game in Python": https://sandyuraz.com/blogs/copilot-game/
Pamięć tłumaczeniowa: https://pl.wikipedia.org/wiki/Pami%C4%99%C4%87_t%C5%82umaczeniowa
"Dear Mr. Robot", Marta Bartnicka & Wojciech Froelich (soap! 2018): https://www.youtube.com/watch?v=Q_if0yBogUQ
Techwriter.pl: http://techwriter.pl/
"Going from A to C, a Practical Approach to Semantic Search", Paweł Kowaluk: https://www.slideshare.net/PawelKowaluk/semantic-search-40766546
Repozytorium GPT-2 na GitHub: https://github.com/openai/gpt-2
#31 Prosty jak budowa cepa, czyli Tech Writer tworzy generator stron statycznych
2021-07-03 21:19:14
Generatorów stron statycznych jest całkiem sporo. Jednak nie jest to powód, dla którego Tech Writer miałby zrezygnować ze stworzenia swojego. A że technoskryba z natury lubi prostotę i przejrzystość to generator też musi mieć takie cechy. Rozmawiamy o tym dlaczego zdecydowaliśmy się na stworzenie własnego rozwiązania, jakiej technologii użyliśmy, co nam to dało i czy było to warte zachodu.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Node.js: https://nodejs.org/
Express.js: https://expressjs.com/
Embedded JavaScript Templates (EJS): https://ejs.co/
Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
React: https://pl.reactjs.org/
Hydration (web development): https://en.wikipedia.org/wiki/Hydration_(web_development)
Docusaurus: https://docusaurus.io/
Next.js: https://nextjs.org/
Python: https://www.python.org/
The Python Standard Library: https://docs.python.org/3/library/
Jinja: https://jinja.palletsprojects.com/en/3.0.x/
Template strings w Pythonie: https://docs.python.org/3/library/string.html#template-strings
JSON Schema: https://json-schema.org/
Generatorów stron statycznych jest całkiem sporo. Jednak nie jest to powód, dla którego Tech Writer miałby zrezygnować ze stworzenia swojego. A że technoskryba z natury lubi prostotę i przejrzystość to generator też musi mieć takie cechy. Rozmawiamy o tym dlaczego zdecydowaliśmy się na stworzenie własnego rozwiązania, jakiej technologii użyliśmy, co nam to dało i czy było to warte zachodu.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Node.js: https://nodejs.org/
Express.js: https://expressjs.com/
Embedded JavaScript Templates (EJS): https://ejs.co/
Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
React: https://pl.reactjs.org/
Hydration (web development): https://en.wikipedia.org/wiki/Hydration_(web_development)
Docusaurus: https://docusaurus.io/
Next.js: https://nextjs.org/
Python: https://www.python.org/
The Python Standard Library: https://docs.python.org/3/library/
Jinja: https://jinja.palletsprojects.com/en/3.0.x/
Template strings w Pythonie: https://docs.python.org/3/library/string.html#template-strings
JSON Schema: https://json-schema.org/
#30 Tech Writer radzi sobie ze sprzężeniem zwrotnym, czyli feedback do dokumentacji
2021-05-19 18:26:54
Naszą dokumentację możemy poprawić tylko wtedy jeśli wiemy jakie kryją się w niej problemy. Warto zbierać i analizować dane od użytkowników, a przede wszystkim pytać ich o opinię. Nie jest to bynajmniej proste zadanie, dlatego połączyliśmy siły z Rafałem Pawlickim, żeby porozmawiać o celach, sposobach, wyzwaniach i dobrych praktykach związanych z procesem zbierania informacji na temat dokumentacji od użytkowników. Staramy się też odpowiedzieć na odwieczne pytanie - jaki jest najlepszy polski odpowiednik słowa "feedback"?
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
"Feedback" w Słowniku Języka Polskiego: https://sjp.pl/feedback
Bounce rate: https://support.google.com/analytics/answer/1009409?hl=en
"Docs as code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
Dokumentacja Microsoft: https://docs.microsoft.com/
Usability Testing: https://en.wikipedia.org/wiki/Usability_testing
"Meet Content po raz pierwszy - relacja": http://techwriter.pl/meet-content-po-raz-pierwszy-relacja/
Card sorting: https://en.wikipedia.org/wiki/Card_sorting
Yandex Metrica: https://metrica.yandex.com/
"What is an Exit Page? (And How to View it in Google Analytics)": https://www.monsterinsights.com/what-is-an-exit-page-and-how-to-view-it-in-google-analytics/
Atlassian Jira: https://www.atlassian.com/software/jira
Google Forms: https://www.google.com/forms/about/
SurveyMonkey: https://www.surveymonkey.com/
"Wyniki badania płac w komunikacji technicznej 2020": http://techwriter.pl/wyniki-badania-plac-w-komunikacji-technicznej-2020/
Rafał Pawlicki (profil LinkedIn): https://pl.linkedin.com/in/rafa%C5%82-pawlicki-973281165
Naszą dokumentację możemy poprawić tylko wtedy jeśli wiemy jakie kryją się w niej problemy. Warto zbierać i analizować dane od użytkowników, a przede wszystkim pytać ich o opinię. Nie jest to bynajmniej proste zadanie, dlatego połączyliśmy siły z Rafałem Pawlickim, żeby porozmawiać o celach, sposobach, wyzwaniach i dobrych praktykach związanych z procesem zbierania informacji na temat dokumentacji od użytkowników. Staramy się też odpowiedzieć na odwieczne pytanie - jaki jest najlepszy polski odpowiednik słowa "feedback"?
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
"Feedback" w Słowniku Języka Polskiego: https://sjp.pl/feedback
Bounce rate: https://support.google.com/analytics/answer/1009409?hl=en
"Docs as code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
Dokumentacja Microsoft: https://docs.microsoft.com/
Usability Testing: https://en.wikipedia.org/wiki/Usability_testing
"Meet Content po raz pierwszy - relacja": http://techwriter.pl/meet-content-po-raz-pierwszy-relacja/
Card sorting: https://en.wikipedia.org/wiki/Card_sorting
Yandex Metrica: https://metrica.yandex.com/
"What is an Exit Page? (And How to View it in Google Analytics)": https://www.monsterinsights.com/what-is-an-exit-page-and-how-to-view-it-in-google-analytics/
Atlassian Jira: https://www.atlassian.com/software/jira
Google Forms: https://www.google.com/forms/about/
SurveyMonkey: https://www.surveymonkey.com/
"Wyniki badania płac w komunikacji technicznej 2020": http://techwriter.pl/wyniki-badania-plac-w-komunikacji-technicznej-2020/
Rafał Pawlicki (profil LinkedIn): https://pl.linkedin.com/in/rafa%C5%82-pawlicki-973281165
#29 Tech Writer koduje według dobrych praktyk
2021-04-08 20:40:25
Pewnego dnia czujesz nieodpartą chęć napisania jakiegoś skryptu. Otwierasz edytor, tworzysz nowy plik i w pocie czoła dodajesz kolejne linijki kodu. Zachowujesz zmiany, wprowadzasz poprawki, weryfikujesz swoje dzieło i powtarzasz cały proces aż po pewnym czasie udaje Ci się doprowadzić skrypt do stanu, w którym robi to co chcesz. Cel osiągnięty. Niby tak, ale czy taki sposób tworzenia kodu jest właściwy?
Rozmawiamy o dobrych praktykach, które kodujący Tech Writer może wdrożyć, żeby łatwiej tworzyć, utrzymywać, zmieniać, ulepszać i udostępniać swoje skrypty i aplikacje.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net , udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Notepad++: https://notepad-plus-plus.org/
Visual Studio (VS) Code: https://code.visualstudio.com/
Git: https://git-scm.com/
Bitbucket: https://bitbucket.org/
GitHub: https://github.com/
GitLab: https://about.gitlab.com/
Pull request w Bitbucket: https://www.atlassian.com/git/tutorials/making-a-pull-request
Subversion (SVN): https://pl.wikipedia.org/wiki/Subversion
Test-driven development: https://pl.wikipedia.org/wiki/Test-driven_development
DITA Open Toolkit: https://www.dita-ot.org/
Lint: https://en.wikipedia.org/wiki/Lint_(software)
Sourcery: https://sourcery.ai/
PyCharm: https://www.jetbrains.com/pycharm/
IntelliJ IDEA: https://www.jetbrains.com/idea/
Cyclomatic complexity: https://en.wikipedia.org/wiki/Cyclomatic_complexity
Wily: https://wily.readthedocs.io/en/latest/
Programowanie funkcyjne: https://pl.wikipedia.org/wiki/Programowanie_funkcyjne
Pewnego dnia czujesz nieodpartą chęć napisania jakiegoś skryptu. Otwierasz edytor, tworzysz nowy plik i w pocie czoła dodajesz kolejne linijki kodu. Zachowujesz zmiany, wprowadzasz poprawki, weryfikujesz swoje dzieło i powtarzasz cały proces aż po pewnym czasie udaje Ci się doprowadzić skrypt do stanu, w którym robi to co chcesz. Cel osiągnięty. Niby tak, ale czy taki sposób tworzenia kodu jest właściwy?
Rozmawiamy o dobrych praktykach, które kodujący Tech Writer może wdrożyć, żeby łatwiej tworzyć, utrzymywać, zmieniać, ulepszać i udostępniać swoje skrypty i aplikacje.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Notepad++: https://notepad-plus-plus.org/
Visual Studio (VS) Code: https://code.visualstudio.com/
Git: https://git-scm.com/
Bitbucket: https://bitbucket.org/
GitHub: https://github.com/
GitLab: https://about.gitlab.com/
Pull request w Bitbucket: https://www.atlassian.com/git/tutorials/making-a-pull-request
Subversion (SVN): https://pl.wikipedia.org/wiki/Subversion
Test-driven development: https://pl.wikipedia.org/wiki/Test-driven_development
DITA Open Toolkit: https://www.dita-ot.org/
Lint: https://en.wikipedia.org/wiki/Lint_(software)
Sourcery: https://sourcery.ai/
PyCharm: https://www.jetbrains.com/pycharm/
IntelliJ IDEA: https://www.jetbrains.com/idea/
Cyclomatic complexity: https://en.wikipedia.org/wiki/Cyclomatic_complexity
Wily: https://wily.readthedocs.io/en/latest/
Programowanie funkcyjne: https://pl.wikipedia.org/wiki/Programowanie_funkcyjne
#28 Tech Writer wybiera narzędzie do kodowania, czyli VS Code kontra IntelliJ IDEA
2021-03-22 14:20:36
Co jest lepsze do pisania kodu - komercyjne środowisko programistyczne czy darmowy edytor kodu źródłowego? Czy takie porównanie w ogóle ma sens?
Michał na co dzień pracuje w IntelliJ IDEA, a Paweł, jak spora część programistów, w VS Code. W tej subiektywnej rozmowie na bardzo subiektywny temat nie staramy się rozstrzygnąć, która aplikacja jest lepsza. Zamiast tego opowiadamy o tym dlaczego zaczęliśmy używać właśnie tych rozwiązań, co w nich lubimy, a co nam przeszkadza i w jakich sytuacjach według nas najlepiej się sprawdzają.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net , udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 .
Informacje dodatkowe:
Stack Overflow Developer Survey 2019: https://insights.stackoverflow.com/survey/2019
Stack Overflow Developer Survey 2020: https://insights.stackoverflow.com/survey/2020
Visual Studio (VS) Code: https://code.visualstudio.com/
IntelliJ IDEA: https://www.jetbrains.com/idea/
IntelliJ IDEA - porównanie wersji Ultimate i Community: https://www.jetbrains.com/idea/features/editions_comparison_matrix.html
Zintegrowane środowisko programistyczne (IDE): https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne
Edytor kodu źródłowego: https://pl.wikipedia.org/wiki/Edytor_kodu_%C5%BAr%C3%B3d%C5%82owego
IDEs vs Code Editors: https://realpython.com/lessons/ides-vs-code-editors/
JavaScript: https://developer.mozilla.org/pl/docs/Web/JavaScript
Cascading Style Sheets (CSS): https://developer.mozilla.org/pl/docs/Learn/Getting_started_with_the_web/CSS_basics
React: https://pl.reactjs.org/
Node.js: https://nodejs.org/en/
Python: https://www.python.org/
Kotlin: https://kotlinlang.org/
Java: https://java.com/en/
TeamCity: https://www.jetbrains.com/teamcity/
Docker: https://www.docker.com/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Prettier: https://prettier.io/
Szkolenie "Modern Python Projects", Sebastian Witowski: https://training.talkpython.fm/courses/modern-python-projects
PyCharm: https://www.jetbrains.com/pycharm/
Language Server Protocol: https://en.wikipedia.org/wiki/Language_Server_Protocol
Vim: https://pl.wikipedia.org/wiki/Vim
VSCodium: https://vscodium.com/
Co jest lepsze do pisania kodu - komercyjne środowisko programistyczne czy darmowy edytor kodu źródłowego? Czy takie porównanie w ogóle ma sens?
Michał na co dzień pracuje w IntelliJ IDEA, a Paweł, jak spora część programistów, w VS Code. W tej subiektywnej rozmowie na bardzo subiektywny temat nie staramy się rozstrzygnąć, która aplikacja jest lepsza. Zamiast tego opowiadamy o tym dlaczego zaczęliśmy używać właśnie tych rozwiązań, co w nich lubimy, a co nam przeszkadza i w jakich sytuacjach według nas najlepiej się sprawdzają.
Muzyka w intro oraz dźwięki pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0.
Informacje dodatkowe:
Stack Overflow Developer Survey 2019: https://insights.stackoverflow.com/survey/2019
Stack Overflow Developer Survey 2020: https://insights.stackoverflow.com/survey/2020
Visual Studio (VS) Code: https://code.visualstudio.com/
IntelliJ IDEA: https://www.jetbrains.com/idea/
IntelliJ IDEA - porównanie wersji Ultimate i Community: https://www.jetbrains.com/idea/features/editions_comparison_matrix.html
Zintegrowane środowisko programistyczne (IDE): https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne
Edytor kodu źródłowego: https://pl.wikipedia.org/wiki/Edytor_kodu_%C5%BAr%C3%B3d%C5%82owego
IDEs vs Code Editors: https://realpython.com/lessons/ides-vs-code-editors/
JavaScript: https://developer.mozilla.org/pl/docs/Web/JavaScript
Cascading Style Sheets (CSS): https://developer.mozilla.org/pl/docs/Learn/Getting_started_with_the_web/CSS_basics
React: https://pl.reactjs.org/
Node.js: https://nodejs.org/en/
Python: https://www.python.org/
Kotlin: https://kotlinlang.org/
Java: https://java.com/en/
TeamCity: https://www.jetbrains.com/teamcity/
Docker: https://www.docker.com/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Prettier: https://prettier.io/
Szkolenie "Modern Python Projects", Sebastian Witowski: https://training.talkpython.fm/courses/modern-python-projects
PyCharm: https://www.jetbrains.com/pycharm/
Language Server Protocol: https://en.wikipedia.org/wiki/Language_Server_Protocol
Vim: https://pl.wikipedia.org/wiki/Vim
VSCodium: https://vscodium.com/