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
#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/
#27 Tech Writer szkoli się z Pythona
2021-02-17 18:43:39
Chcesz lepiej rozumieć kod, który opisujesz? Chcesz zautomatyzować żmudne aspekty swojej pracy? Chcesz móc powiedzieć śmiało i dumnie - znam Pythona?
W tym odcinku rozmawiamy z Adrianem Gonciarzem, który prowadzi szkolenia z Pythona dla tech writerów i testerów, oraz Basią Czyż, technical writerką, która wzięła udział w tym szkoleniu.
Szkolenie odbyło się w pełni online i składało się z dwugodzinnych bloków trzy razy w tygodniu. W jego toku, uczestnicy stworzyli dwa projekty i nauczyli się solidnych podstaw Pythona. Od naszych gości dowiadujemy się jak szkolenie wygląda od kulis oraz jaką wiedzę można z niego wynieść. Dostajemy opinię organizatora i uczestnika, a przy tym jesteśmy świadkami bardzo ciekawej dyskusji o roli kodowania w pracy technical writera oraz o przyszłości tego 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:
Szkolenie "Python for Testers and Technical Writers": https://dredar.com/services/trainings-and-workshops/python-for-testers-and-technical-writers
Site Reliability Engineering (SRE): https://en.wikipedia.org/wiki/Site_reliability_engineering
DREDAR: https://dredar.com/
Techwriter.pl: http://techwriter.pl/
"Tech Writer koduje w Pythonie. Przewodnik szybkiego startu": https://techwriterkoduje.pl/docs/teoria
"Automate the Boring Stuff with Python": https://automatetheboringstuff.com/
"The PEP 8 Song", Leon Sandoy: https://www.youtube.com/watch?v=hgI0p1zf31k
"PEP 20 - The Zen of Python": https://www.python.org/dev/peps/pep-0020/
Sebastian Witowski, Python consultant and trainer: https://switowski.com/
Chcesz lepiej rozumieć kod, który opisujesz? Chcesz zautomatyzować żmudne aspekty swojej pracy? Chcesz móc powiedzieć śmiało i dumnie - znam Pythona?
W tym odcinku rozmawiamy z Adrianem Gonciarzem, który prowadzi szkolenia z Pythona dla tech writerów i testerów, oraz Basią Czyż, technical writerką, która wzięła udział w tym szkoleniu.
Szkolenie odbyło się w pełni online i składało się z dwugodzinnych bloków trzy razy w tygodniu. W jego toku, uczestnicy stworzyli dwa projekty i nauczyli się solidnych podstaw Pythona. Od naszych gości dowiadujemy się jak szkolenie wygląda od kulis oraz jaką wiedzę można z niego wynieść. Dostajemy opinię organizatora i uczestnika, a przy tym jesteśmy świadkami bardzo ciekawej dyskusji o roli kodowania w pracy technical writera oraz o przyszłości tego 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:
Szkolenie "Python for Testers and Technical Writers": https://dredar.com/services/trainings-and-workshops/python-for-testers-and-technical-writers
Site Reliability Engineering (SRE): https://en.wikipedia.org/wiki/Site_reliability_engineering
DREDAR: https://dredar.com/
Techwriter.pl: http://techwriter.pl/
"Tech Writer koduje w Pythonie. Przewodnik szybkiego startu": https://techwriterkoduje.pl/docs/teoria
"Automate the Boring Stuff with Python": https://automatetheboringstuff.com/
"The PEP 8 Song", Leon Sandoy: https://www.youtube.com/watch?v=hgI0p1zf31k
"PEP 20 - The Zen of Python": https://www.python.org/dev/peps/pep-0020/
Sebastian Witowski, Python consultant and trainer: https://switowski.com/
#26 Tech Writerzy dokumentują API
2021-02-10 15:04:33
Pisanie dokumentacji do API to dziedzina sama w sobie, która w dzisiejszych czasach zyskuje na znaczeniu. Przyspieszony rozwój technologii cyfrowych w dobie pandemii i pracy zdalnej podniósł znaczenie dokumentacji w ogóle, a dokumentacji do API w szczególności.
Z naszymi gośćmi, Jadwigą Sitnicką z LogMeIn, Mateuszem Wiktorem z PubNub i Pawłem Krentowskim z Ocado Technology, rozmawiamy m.in. o tym z jakich elementów składa się dokumentacja do API, kto i w jaki sposób tworzy poszczególne części, jakie są najczęstsze problemy i wyzwania podczas tworzenia tego typu dokumentacji oraz jakie narzędzia warto znać.
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:
Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji
LogMeIn: https://www.logmein.com/
Ocado Technology: https://www.ocadogroup.com/technology/technology-pioneers
PubNub: https://www.pubnub.com/
"The State of API Report 2020": https://smartbear.com/resources/ebooks/the-state-of-api-2020-report/
Markdown: https://daringfireball.net/projects/markdown/syntax
ReadMe.io: https://readme.com/
Stoplight Studio: https://stoplight.io/studio/
OpenAPI: https://www.openapis.org/
Swagger UI: https://swagger.io/tools/swagger-ui/
ReDoc: https://github.com/Redocly/redoc
Jekyll: https://jekyllrb.com/
GitLab: https://about.gitlab.com/
curl: https://curl.se/
Postman: https://www.postman.com/
Visual Studio Code: https://code.visualstudio.com/
Software Development Kit (SDK): https://pl.wikipedia.org/wiki/Software_development_kit
Integrated Development Environment (IDE): https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne
"Wstęp do REST API": https://devszczepaniak.pl/wstep-do-rest-api/
Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji
Pisanie dokumentacji do API to dziedzina sama w sobie, która w dzisiejszych czasach zyskuje na znaczeniu. Przyspieszony rozwój technologii cyfrowych w dobie pandemii i pracy zdalnej podniósł znaczenie dokumentacji w ogóle, a dokumentacji do API w szczególności.
Z naszymi gośćmi, Jadwigą Sitnicką z LogMeIn, Mateuszem Wiktorem z PubNub i Pawłem Krentowskim z Ocado Technology, rozmawiamy m.in. o tym z jakich elementów składa się dokumentacja do API, kto i w jaki sposób tworzy poszczególne części, jakie są najczęstsze problemy i wyzwania podczas tworzenia tego typu dokumentacji oraz jakie narzędzia warto znać.
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:
Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji
LogMeIn: https://www.logmein.com/
Ocado Technology: https://www.ocadogroup.com/technology/technology-pioneers
PubNub: https://www.pubnub.com/
"The State of API Report 2020": https://smartbear.com/resources/ebooks/the-state-of-api-2020-report/
Markdown: https://daringfireball.net/projects/markdown/syntax
ReadMe.io: https://readme.com/
Stoplight Studio: https://stoplight.io/studio/
OpenAPI: https://www.openapis.org/
Swagger UI: https://swagger.io/tools/swagger-ui/
ReDoc: https://github.com/Redocly/redoc
Jekyll: https://jekyllrb.com/
GitLab: https://about.gitlab.com/
curl: https://curl.se/
Postman: https://www.postman.com/
Visual Studio Code: https://code.visualstudio.com/
Software Development Kit (SDK): https://pl.wikipedia.org/wiki/Software_development_kit
Integrated Development Environment (IDE): https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne
"Wstęp do REST API": https://devszczepaniak.pl/wstep-do-rest-api/
Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji
#25 Tech Writer koduje w dokumentacji, czyli Markdown w wersji rozszerzonej
2021-01-21 15:10:11
Markdown to prosty i lekki język znaczników, który w ostatnich latach zyskał sporą popularność, szczególnie w świecie dokumentacji dla programistów. Pozwala nam on łatwo i szybko stworzyć tekst, a następnie opublikować go jako HTML. Z biegiem czasu pojawiły się różne odmiany i rozszerzenia Markdowna, pozwalające wycisnąć z niego jeszcze więcej. Jednym z nich jest MDX, który pozwala na używanie bezpośrednio w tekście elementów JSX. Takie rozwiązanie otwiera przed nami nowe możliwości, jak na przykład opcję umieszczenia w dokumentacji interaktywnej próbki kodu. Dzięki temu możemy przesunąć naszą dokumentację na wyższy poziom. Rozmawiamy o tym czym jest MDX, jakie daje nam możliwości i w jakich sytuacjach może nam się przydać.
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:
Markdown: https://daringfireball.net/projects/markdown/syntax
MDX: https://mdxjs.com/
Wprowadzenie do JSX: https://pl.reactjs.org/docs/introducing-jsx.html
React: https://pl.reactjs.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/
Docusaurus v2: https://v2.docusaurus.io/
Gatsby: https://www.gatsbyjs.com/
Next.js: https://nextjs.org/
Create React app: https://github.com/facebook/create-react-app
Carbon React: https://react.carbondesignsystem.com/
React Bootstrap: https://react-bootstrap.github.io/
Swagger UI: https://swagger.io/tools/swagger-ui/
webpack: https://webpack.js.org/
Markdown to prosty i lekki język znaczników, który w ostatnich latach zyskał sporą popularność, szczególnie w świecie dokumentacji dla programistów. Pozwala nam on łatwo i szybko stworzyć tekst, a następnie opublikować go jako HTML. Z biegiem czasu pojawiły się różne odmiany i rozszerzenia Markdowna, pozwalające wycisnąć z niego jeszcze więcej. Jednym z nich jest MDX, który pozwala na używanie bezpośrednio w tekście elementów JSX. Takie rozwiązanie otwiera przed nami nowe możliwości, jak na przykład opcję umieszczenia w dokumentacji interaktywnej próbki kodu. Dzięki temu możemy przesunąć naszą dokumentację na wyższy poziom. Rozmawiamy o tym czym jest MDX, jakie daje nam możliwości i w jakich sytuacjach może nam się przydać.
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:
Markdown: https://daringfireball.net/projects/markdown/syntax
MDX: https://mdxjs.com/
Wprowadzenie do JSX: https://pl.reactjs.org/docs/introducing-jsx.html
React: https://pl.reactjs.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/
Docusaurus v2: https://v2.docusaurus.io/
Gatsby: https://www.gatsbyjs.com/
Next.js: https://nextjs.org/
Create React app: https://github.com/facebook/create-react-app
Carbon React: https://react.carbondesignsystem.com/
React Bootstrap: https://react-bootstrap.github.io/
Swagger UI: https://swagger.io/tools/swagger-ui/
webpack: https://webpack.js.org/
#24 Tech Writer publikuje inaczej, czyli API do dokumentacji
2020-12-23 14:30:45
Niektóre sposoby publikowania dokumentacji są znane wśród Tech Writerów od zarania dziejów. Portale serwujące wszelakiej maści treści w formacie HTML czy PDF są niejako standardem branżowym. W sytuacji kiedy odbiorcą dokumentacji jest użytkownik produktu te formy spełniają swoje zadanie. Ale co zrobić kiedy do naszej dokumentacji potrzebuje się dobrać jakaś aplikacja? Na przykład, aplikacja webowa chce wyświetlić dokumentację w panelu, który jest jej integralną cześcią. Możemy wtedy zastosować stary dobry "iframe", jednak takie rozwiązanie nie jest zalecane, a do tego stwarza szereg problemów. A może by tak stworzyć API dla dokumentacji i serwować treść za pomocą endpointów? Rozważamy czy takie rozwiązanie jest możliwe, czy ma sens i w jakich sytuacjach mogłoby się sprawdzić.
Informacje dodatkowe:
Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji
Tag <iframe>: https://www.w3schools.com/tags/tag_iframe.ASP
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
Elastic (Elasticsearch, Kibana): https://www.elastic.co/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Adobe FrameMaker: https://pl.wikipedia.org/wiki/Adobe_FrameMaker
Markdown: https://daringfireball.net/projects/markdown/syntax
Gatsby: https://www.gatsbyjs.com/
GraphQL: https://graphql.org/
React: https://pl.reactjs.org/
Niektóre sposoby publikowania dokumentacji są znane wśród Tech Writerów od zarania dziejów. Portale serwujące wszelakiej maści treści w formacie HTML czy PDF są niejako standardem branżowym. W sytuacji kiedy odbiorcą dokumentacji jest użytkownik produktu te formy spełniają swoje zadanie. Ale co zrobić kiedy do naszej dokumentacji potrzebuje się dobrać jakaś aplikacja? Na przykład, aplikacja webowa chce wyświetlić dokumentację w panelu, który jest jej integralną cześcią. Możemy wtedy zastosować stary dobry "iframe", jednak takie rozwiązanie nie jest zalecane, a do tego stwarza szereg problemów. A może by tak stworzyć API dla dokumentacji i serwować treść za pomocą endpointów? Rozważamy czy takie rozwiązanie jest możliwe, czy ma sens i w jakich sytuacjach mogłoby się sprawdzić.
Informacje dodatkowe:
Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji
Tag <iframe>: https://www.w3schools.com/tags/tag_iframe.ASP
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
Elastic (Elasticsearch, Kibana): https://www.elastic.co/
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Adobe FrameMaker: https://pl.wikipedia.org/wiki/Adobe_FrameMaker
Markdown: https://daringfireball.net/projects/markdown/syntax
Gatsby: https://www.gatsbyjs.com/
GraphQL: https://graphql.org/
React: https://pl.reactjs.org/
#23 Tech Writer mierzy jakość dokumentacji, czyli co i jak sprawdzać
2020-11-23 14:14:46
Jak zrobić najlepszą dokumentację? Ustalamy wewnętrzne standardy i się ich trzymamy, a potem sprawdzamy czy dokumentacja spełnia swoje cele. Następnie weryfikujemy standardy, żeby nasza dokumentacja spełniała założone cele coraz lepiej.
Wydaje się proste, ale diabeł tkwi w szczegółach. Z Rafałem Pawlickim zastanawiamy się jak utrzymywać wewnętrzne standardy jednocześnie ucząc ludzi pisania dobrej dokumentacji oraz w jaki sposób mierzyć efektywność dokumentacji. Rozmawiamy o tym jak stworzyć model oceny dokumentacji pod kątem jakości i dojrzałości, a następnie jak wykorzystać te informacje do planowania pracy dokumentacyjnej. Przyglądamy się też zbieraniu danych od użytkowników oraz wykorzystywaniu ich do wdrażania zmian w organizacji.
Które metryki najlepiej sprawdzały się dla nas do tej pory? Które działają najlepiej osobno, a które w połączeniu? Które elementy może sprawdzać automat, a które powinny być weryfikowane przez człowieka? Posłuchajcie, a potem dajcie nam znać jakie Wy macie sposoby i pomysły na mierzenie jakości dokumentacji.
Informacje dodatkowe:
Hemingway App: http://www.hemingwayapp.com/
LanguageTool: https://languagetool.org/
Readability indices: https://www.analyzemywriting.com/readability_indices.html
Konferencja Write the Docs 2020 w Pradze: https://www.writethedocs.org/conf/prague/2020/
"Organizing a Confluence hoard, or, does this page spark joy?", Abigail Sutherland: https://www.youtube.com/watch?v=DrGCWTxeA94&list=PLZAeFn6dfHpmRWZJaUwQzsdagW2TtRI2x&index=3
"The Importance of Using Analytics and Feedback for your Documentation", Karissa Van Baulen: https://www.youtube.com/watch?v=EkPU2afWPDA&list=PLZAeFn6dfHpmRWZJaUwQzsdagW2TtRI2x&index=13
Google Analytics: https://analytics.google.com/analytics/web/provision/#/provision
Google Tag Manager: https://marketingplatform.google.com/about/tag-manager/
Jak zrobić najlepszą dokumentację? Ustalamy wewnętrzne standardy i się ich trzymamy, a potem sprawdzamy czy dokumentacja spełnia swoje cele. Następnie weryfikujemy standardy, żeby nasza dokumentacja spełniała założone cele coraz lepiej.
Wydaje się proste, ale diabeł tkwi w szczegółach. Z Rafałem Pawlickim zastanawiamy się jak utrzymywać wewnętrzne standardy jednocześnie ucząc ludzi pisania dobrej dokumentacji oraz w jaki sposób mierzyć efektywność dokumentacji. Rozmawiamy o tym jak stworzyć model oceny dokumentacji pod kątem jakości i dojrzałości, a następnie jak wykorzystać te informacje do planowania pracy dokumentacyjnej. Przyglądamy się też zbieraniu danych od użytkowników oraz wykorzystywaniu ich do wdrażania zmian w organizacji.
Które metryki najlepiej sprawdzały się dla nas do tej pory? Które działają najlepiej osobno, a które w połączeniu? Które elementy może sprawdzać automat, a które powinny być weryfikowane przez człowieka? Posłuchajcie, a potem dajcie nam znać jakie Wy macie sposoby i pomysły na mierzenie jakości dokumentacji.
Informacje dodatkowe:
Hemingway App: http://www.hemingwayapp.com/
LanguageTool: https://languagetool.org/
Readability indices: https://www.analyzemywriting.com/readability_indices.html
Konferencja Write the Docs 2020 w Pradze: https://www.writethedocs.org/conf/prague/2020/
"Organizing a Confluence hoard, or, does this page spark joy?", Abigail Sutherland: https://www.youtube.com/watch?v=DrGCWTxeA94&list=PLZAeFn6dfHpmRWZJaUwQzsdagW2TtRI2x&index=3
"The Importance of Using Analytics and Feedback for your Documentation", Karissa Van Baulen: https://www.youtube.com/watch?v=EkPU2afWPDA&list=PLZAeFn6dfHpmRWZJaUwQzsdagW2TtRI2x&index=13
Google Analytics: https://analytics.google.com/analytics/web/provision/#/provision
Google Tag Manager: https://marketingplatform.google.com/about/tag-manager/
#22 Tech Writer buduje dokumentację API, czyli Next.js, ReDoc i OpenAPI w akcji
2020-10-18 21:50:38
Next.js to framework Reacta, dzięki któremu można w elastyczny sposób tworzyć nowoczesne strony internetowe. Według rankingu na stronie staticgen.com, jest to również jeden z najpopularniejszych generatorów stron statycznych. Rozmawiamy o tym jak można połączyć Next.js z narzędziem ReDoc, żeby zbudować stronę z dokumentacją dla wielu API stworzonych przy pomocy specyfikacji OpenAPI. Zastanawiamy się też jak Next.js może nam się przydać kiedy piszemy dokumentację w standardzie DITA.
Informacje dodatkowe:
Next.js: https://nextjs.org/
React: https://pl.reactjs.org/
Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
StaticGen: https://www.staticgen.com/
Docusaurus: https://docusaurus.io/
Gatsby: https://www.gatsbyjs.com/
ReDoc: https://github.com/Redocly/redoc
OpenAPI: https://www.openapis.org/
Swagger UI: https://swagger.io/tools/swagger-ui/
swagger-ui-react: https://www.npmjs.com/package/swagger-ui-react
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Wtyczki dla DITA OT: https://www.dita-ot.org/plugins
Wtyczka Swagger dla DITA OT: https://github.com/jason-fox/fox.jason.passthrough.swagger
Next.js to framework Reacta, dzięki któremu można w elastyczny sposób tworzyć nowoczesne strony internetowe. Według rankingu na stronie staticgen.com, jest to również jeden z najpopularniejszych generatorów stron statycznych. Rozmawiamy o tym jak można połączyć Next.js z narzędziem ReDoc, żeby zbudować stronę z dokumentacją dla wielu API stworzonych przy pomocy specyfikacji OpenAPI. Zastanawiamy się też jak Next.js może nam się przydać kiedy piszemy dokumentację w standardzie DITA.
Informacje dodatkowe:
Next.js: https://nextjs.org/
React: https://pl.reactjs.org/
Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
StaticGen: https://www.staticgen.com/
Docusaurus: https://docusaurus.io/
Gatsby: https://www.gatsbyjs.com/
ReDoc: https://github.com/Redocly/redoc
OpenAPI: https://www.openapis.org/
Swagger UI: https://swagger.io/tools/swagger-ui/
swagger-ui-react: https://www.npmjs.com/package/swagger-ui-react
Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
Wtyczki dla DITA OT: https://www.dita-ot.org/plugins
Wtyczka Swagger dla DITA OT: https://github.com/jason-fox/fox.jason.passthrough.swagger