Tech writer koduje

Sortuj: kategoriami | alfabetycznie
Najpopularniejsze w tygodniu
Opis: 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.
Data dodania: 2019-06-06 20:57:25
Data aktualizacji: 2020-12-03 23:15:09
Audycji w katalogu: 23
Stan:
Wciąż na fali (aktywny)
opublikowany 10 dni temu
#23 Tech Writer mierzy jakość dokumentacji, czyli co i jak sprawdzać
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: [link] LanguageTool: [link] Readability indices: [link] Konferencja Write the Docs 2020 w Pradze: [link];  "Organizing a Confluence hoard, or, does this page spark joy?", Abigail Sutherland: [link] "The Importance of Using Analytics and Feedback for your Documentation", Karissa Van Baulen: [link] Google Analytics: [link] Google Tag Manager: [link]
pobierz 69.5 MB odcinki RSS iTunes www
opublikowany 2 miesiące temu
#22 Tech Writer buduje dokumentację API, czyli Next.js, ReDoc i OpenAPI w akcji
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: [link] React: [link] Static Site Generator: [link] StaticGen: [link] Docusaurus:  [link] Gatsby: [link] ReDoc: [link] OpenAPI: [link] Swagger UI: [link] swagger-ui-react: [link] Standard DITA (Darwin Information Typing Architecture): [link] Wtyczki dla DITA OT: [link] Wtyczka Swagger dla DITA OT: [link]
pobierz 33.3 MB odcinki RSS iTunes www
opublikowany 3 miesiące temu
#21 Tech Writer zbiera informacje ze stron, czyli jak można wykorzystać web scraping
Web scraping to zbieranie danych ze stron internetowych. Google, na przykład, robi to, żeby indeksować cały internet w swojej wyszukiwarce. Web scraping wykorzystuje się też do monitorowania cen w konkurencyjnych sklepach internetowych. U nas w firmie używamy web scrapingu, żeby indeksować dokumentację dla naszej wyszukiwarki. To samo rozwiązanie wykorzystujemy też, żeby sprawdzać czy wszystkie linki działają. Wyniki web scrapingu zapisujemy  w Elasticsearchu, a potem analizujemy je za pomocą raportów i filtrów  w Kibanie. Dzięki temu stworzyliśmy zalążek panelu kontrolnego, na którym widać aktualną jakość naszej dokumentacji. W niedalekiej przyszłości chcemy  rozszerzyć nasze rozwiązanie o dodatkowe funkcje. Planujemy, na przykład, testować strony pod kątem wymaganych elementów i zgodności z regułami  naszego style guide’a. Kolejną opcją jest sprawdzanie czy w treści nie ma błędów gramatycznych i stylistycznych oraz czy język, którego używamy do tworzenia instrukcji jest wystarczająco przejrzysty. Co można jeszcze zrobić za pomocą web scrapingu? Jakie inne testy są potrzebne w świecie dokumentacji technicznej i pisania ustrukturyzowanego? Zapraszamy do słuchania. Informacje dodatkowe: Web scraping: [link] Scrapy: [link] Elastic (Elasticsearch, Kibana): [link] curl: [link] Textstat: [link] spaCy: [link] Selenium: [link] TestCafe: [link] Vale: [link]
pobierz 39.2 MB odcinki RSS iTunes www
opublikowany 4 miesiące temu
#20 Tech Writer optymalizuje, czyli web performance w dokumentacji
Wydajność to temat rzadko poruszany w tech writingu, pomimo tego, że webowa forma dokumentacji jest bardzo popularna. Czy szybkość ładowania stron ma znaczenie dla naszych odbiorców? A jeśli tak, to czy Tech Writer ma jakiś wpływ na wydajność dokumentacji? Rozmawiamy o tym jak mierzyć i poprawiać web performance. Zastanawiamy się co może zrobić w tej kwestii Tech Writer, a co musi wdrożyć programista lub inżynier DevOps. Wreszcie rozmawiamy o tym, że w dokumentacji performance to nie wszystko. Informacje dodatkowe: Web performance: [link] "How to Improve Your Page Load Speed by 70.39% in 45 Minutes": [link] TinyPNG: [link] ImageMagick: [link] Gzip: [link] Chunking w standardzie DITA: [link] Minifikacja: [link] HTTP caching: [link] WordPress: [link] "What Are Static Site Generators?": [link] Google PageSpeed Insights: [link] Google Lighthouse: [link] Docusaurus: [link]
pobierz 45.9 MB odcinki RSS iTunes www
opublikowany 5 miesięcy temu
#19 Tech Writer pracuje zdalnie, czyli jak to się robi w GitLabie
Trwająca od kilku miesięcy sytuacja spowodowała, że biura zostały pozamykane a praca zdalna z dnia na dzień stała się nowym standardem. Jednak istnieją też takie firmy, które już na wczesnym etapie rozwoju podjęły świadomą decyzję, że postawią na model pracy bez tradycyjnych biur. O byciu w pełni zdalnym Technical Writerem rozmawiamy z Marcinem Sędłakiem-Jakubowskim z firmy GitLab. Pytamy o procesy, narzędzia, budowanie relacji i staramy się ustalić czy jest w tym wszystkim jakiś haczyk. Informacje dodatkowe: About GitLab: [link] GitLab Handbook: [link] GitLab Unfiltered: [link]; All-Remote Meetings: [link] Creating GitLab’s remote playbook: [link] Visual Studio Code: [link] Manjaro Linux: [link] Vale: [link] Vim: [link] Nanoc: [link]
pobierz 64.3 MB odcinki RSS iTunes www
opublikowany 6 miesięcy temu
#18 Wyboista droga do kodowania
Przejście od zera do kodującego Tech Writera to dość długa droga, i nie zawsze usłana różami. Jednak przy odpowiedniej motywacji i podejściu można podołać temu wyzwaniu. Rozmawiamy o tym jak zacząć naukę kodowania, przez jakie etapy trzeba przejść i jak radzić sobie z problemami i pułapkami. Informacje dodatkowe: Why Learning To Code Is So Damn Hard: [link] Skillshare: [link] Codecademy: [link] Stack Overflow: [link]
pobierz 57.6 MB odcinki RSS iTunes www
opublikowany 7 miesięcy temu
#17 Webhelp kontra Progressive Web App
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: [link] "About Webhelp Output" (pomoc MadCap Flare 2017r3): [link] Progressive Web Application: [link] "Co zmieniają Progressive Web Applications? Wszystko, co musisz wiedzieć o PWA": [link] Oxygen Webhelp: [link]
pobierz 38.9 MB odcinki RSS iTunes www
opublikowany 8 miesięcy temu
16# DITA z Gita
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): [link] Component Content Management System (CCMS): [link] DITA Open Toolkit: [link] Git: [link] DITA for Small Teams: [link] Python: [link] IntelliJ IDEA: [link] Poetry: [link] Gradle: [link] Lightweight DITA: [link] Oxygen XML: [link] Schematron: [link] Apache Ant: [link] Extensible Stylesheet Language Transformations (XSLT): [link] Pytest: [link] Git submodules:  [link] Continuous integration (CI):  [link] TeamCity: [link] npm: [link] Docker: [link] Bitbucket: [link] Progressive web apps: [link] Prince XML: [link]
pobierz 41.1 MB odcinki RSS iTunes www
opublikowany 8 miesięcy temu
#15 Technoskryby potyczki z SME, czyli jak zdobywać informacje potrzebne do tworzenia dokumentacji
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.
pobierz 81.4 MB odcinki RSS iTunes www
opublikowany 8 miesięcy temu
#14 Tech Writer zaczyna kodować w Pythonie, czyli o narzędziach i dobrych praktykach
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: [link] Intellij IDEA: [link] PyCharm: [link] Visual Studio Code (VS Code): [link] Vim: [link] pyenv: [link] Python venv: [link] Python virtualenv: [link] Conda: [link] Node modules: [link] Pipenv: [link] Poetry: [link] Python Requests: [link] Django: [link] Flask: [link] EuroPython 2019: [link] Cookiecutter: [link] Pipx: [link] Black: [link] npm: [link] npx: [link] "The Hitchhiker’s Guide to Python!", Kenneth Reitz, Tanya Schlusser: [link] Sphinx: [link] Write the Docs: [link] Pytest: [link] Python unittest: [link] Test Driven Development (TDD): [link] Git: [link] Warsztat "Modern Python Developer's Toolkit": [link] Pykonik, Kraków Python User Group: [link] Profil Sebastiana na LinkedIn: [link] Profil Sebastiana na Twitterze: [link] Strona Sebastiana: [link]
pobierz 58.2 MB odcinki RSS iTunes www
opublikowany 9 miesięcy temu
#13 Full-Stack Tech Writer, czyli technoskryba kontra chmura
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!: [link] Standard DITA (Darwin Information Typing Architecture): [link] Markdown: [link] DITA Open Toolkit: [link] Component content management system (CCMS): [link] Node.js: [link] Python: [link] Scrapy: [link] Jinja2: [link] Sphinx: [link] Elasticsearch: [link] Kubernetes: [link]
pobierz 57.3 MB odcinki RSS iTunes www
opublikowany 11 miesięcy temu
#12 Tech Writer się rekrutuje, czyli jak ważne 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.
pobierz 62.5 MB odcinki RSS iTunes www
opublikowany 12 miesięcy temu
#11 Robot dokumentuje część 2 - automatyzacja kontra ludzie
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: [link] MadCap Software: [link] Konferencja Tłumaczy: [link]
pobierz 60.7 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#10 Docusaurus - Tech Writer dokarmia dinozaury
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: [link] Using Docusaurus to Create Open Source Websites: [link] React: [link] Crowdin: [link] StaticGen: [link] I'd Rather Be Writing: [link] Tech Writer koduje: [link]
pobierz 49.9 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#9 Robot dokumentuje, czyli technical writing przyszłości
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: [link] "10 skills you'll need to survive the rise of automation", World Economic Forum: [link] "JPMorgan Chase inks 5-year deal to generate marketing copy via AI", Marketing Dive: [link] Horse ebooks (Twitter bot): [link] Bot or not: [link] "Can science writing be automated?", MIT News: [link] "Lithium-Ion Batteries. A Machine-Generated Summary of Current Research", Springer: [link] "The Rise of the Robot Reporter", New York Times: [link] Konferencja Tłumaczy: [link]
pobierz 135.2 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#8 DITA OT - static site generator dla wtajemniczonych
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): [link] Konsorcjum OASIS: [link] DITA Open Toolkit: [link] Lightweight DITA: [link] Extensible Stylesheet Language Transformations (XSLT): [link] XSL Formatting Objects (FO): [link] Syncro Soft: [link] Oxygen XML: [link] Oxygen Webhelp: [link] easyDITA: [link] Schematron: [link] Apache Ant: [link] Wtyczka Gradle dla DITA OT: [link] Adobe Experience Manager: [link] Markdown: [link] reStructuredText: [link] AsciiDoc: [link] Sphinx: [link] StaticGen: [link]
pobierz 119.2 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#7 Programista dokumentuje, czyli nowoczesny technical writing
W nowoczesnej firmie software’owej nie ma ani jednego Technical Writera. W takim razie czym się zajmuje nasz gość, Rafał Pawlicki, który pracuje jako Documentation Manager? Dynamiczne zmiany w świecie technologii powodują, że coraz częściej w firmach wytwarzających oprogramowanie granice między tradycyjnie zdefiniowanymi rolami zaczynają się zacierać. Nierzadko Tech Writer koduje, a programista dokumentuje. Rozmawiamy o przyszłości Technical Writerów, o tym jak stać się elastycznym specjalistą od treśći i nie zamykać się w silosie oraz mierzymy się ze stereotypami związanymi z podejściem programistów do dokumentacji i z ich postrzeganiem roli Tech Writera. Posłuchajcie! Informacje dodatkowe: Atlassian Confluence: [link] Sphinx: [link] Markdown: [link] reStructuredText: [link] PyCharm: [link] IntelliJ IDEA: [link] Rafał Pawlicki (profil LinkedIn): [link]
pobierz 142.9 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#6 Konferencja EuroPython 2019 z perspektywy kodującego Tech Writera
EuroPython to największa europejska konferencja poświęcona językowi programowania Python. Tegoroczna edycja odbyła się w dniach 8-14 lipca w Bazylei (Szwajcaria).  Przyglądamy się temu wydarzeniu z perspektywy Technical Writera, który od jakiegoś czasu korzysta  z Pythona w swojej pracy, ale nie jest zawodowym programistą. Rozmawiamy o tym co się działo podczas EuroPython 2019 i czego można było się tam nauczyć. Informacje dodatkowe: Konferencja EuroPython 2019:   [link]   Nagrania wystąpień z EuroPython 2019:  [link] Budowanie mechanizmu rekomendacji w Pythonie:   [link]   Dekoratory w Pythonie:   [link]   Narzędzie poetry:   [link]   "Modern Python Standard Library Cookbook", Alessandro Molina:   [link]   Baza danych MongoDB: [link] Konferencja PyCon PL 2019:   [link]  
pobierz 102.3 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#5 Narzędzia dla Tech Writerów
Mogłoby się wydawać, że Tech Writerzy nie mają dużych potrzeb jeśli chodzi o narzędzia. W końcu co może być potrzebne do napisania instrukcji? Zapewne wystarczy jakiś prosty edytor i tyle. Nic bardziej mylnego. Technical Writerzy, jak każda profesja, również mają swoje rozwiązania, które pozwalają im tworzyć, dostarczać i łatwiej utrzymywać profesjonalną dokumentację. W dzisiejszym odcinku przyglądamy się temu z jakich narzędzi mogą skorzystać osoby zajmujące się tworzeniem treści, podsumowujemy ich mocne i słabe strony i staramy się ustalić w jakich sytuacjach najlepiej się sprawdzają. Informacje dodatkowe: Quark XML Author for Microsoft Word: [link] Schema ST4: [link] MadCap Flare: [link] Help and Manual: [link] Adobe RoboHelp: [link] OpenAPI: [link] Swagger UI: [link] ReadMe.io: [link] DapperDox: [link] easyDITA: [link] Snagit: [link] draw.io: [link] Inkscape: [link] GIMP: [link] DaVinci Resolve: [link] Visual Studio Code: [link] The Jupyter Notebook: [link] Storybook: [link] DocToolHub: [link] StaticGen: [link]
pobierz 117.6 MB odcinki RSS iTunes www
opublikowany ponad rok temu
#4 Konferencja soap! 2019 - podsumowanie
soap! to jedyna polska konferencja dla specjalistów zajmujących się szeroko pojętą treścią. Motywem przewodnim tegorocznej edycji było "Content as code". W tym odcinku, dzielimy się swoimi ogólnymi wrażeniami na temat konferencji oraz rozmawiamy o prezentacjach, które najbardziej zapadły w nam pamięć. Informacje dodatkowe: Konferencja soap!: [link] Grupa "#soapconf & #meetcontent community" na Facebooku: [link] Projekt Kyma: [link]
pobierz 87.5 MB odcinki RSS iTunes www
Starsze
»
miodek