Technical Writing 101 🇺🇦

environmental documentation

Допомоги/Підтримки пост Гайз, хочемо поділитись з вами штучним інтелектом який може створити унікальне зображення чого завгодно, в будь-якому стилі, треба просто описати це за допомогою тексту 📝 Чим докладніше опис - тим краще😉 P.S. частина коштів йде на допомогу бійцям полку 3 штурмової бригади.💙💛 P.P.S Картинка згенерована по запиту "A person writing a post for technical writing blog", seems close enough

В дев-коммьюнити ReadME которій хостит GitHub вышел годный пост про ведение рабрчих заметок. В этом блогпосте рассматривается важность документирования знаний посредством вдумчивого ведения заметок и то, как построение командной культуры на основе этой практики может улучшить коллективное понимание. Применяя такой подход к ведению заметок, команды легко алайнятся в совместной работе и находятся "on the same page" в плане понимания важной информации и идей. 🔗 Читать: Documenting knowledge: a guide to successful note-taking

У Ноушна намечается что-то очень интересное! Бойтесь, писатели, оно уже пишет всё за нас! Минутная видео-презентация по ссылочке. 👀 Смотреть: Introducing Notion AI

Ну штош, будем попробовать. Без поддержки Asciidoc не так интересно, как хотелось бы, но все еще хз даже чего ожидать

Зарелезилась популярная платформа для документации GitBook, теперь версия 3.0 Что нового? - Частичный редизайн UI-ки публичных страничек. - В хэдере появилась возможность делать меню с дропдаунами. - Поиск переехал в правый верхний угол. - Края элементов, по веянию моды, скруглились почти везде - Новенькие шрифты - Новый элемент для лендингов: block: cards - Интеграции! Интеграции: - Arcade - Fathom - Figma - Google Analytics - Intercom - Jira - Linear - Mailchimp - Mermaid - Plausible - RunKit - Sentry Полный перечень изменений и пояснение, что каждая интеграция умеет в полной статье в официальном блоге. 🔗 Читать: GitBook 3.0: Document everything, from start to ship

📕 Хороший, годный тред на Хакерньюс, где пользователи ресурса делятся полезными и популярными книгами про техрайтинг, в комментах можно найти ссылочки на аналогичные треды, где контентика еще больше. Выцеживать оттуда ссылки мне откровенно лениво, поэтому наслаждайтесь as is, годных советов там валом. 🔗 Читать: Ask HN: Any great books about technical writing? #book #resource #career #en

Редакция очень любит комиксы, хоть в последнее время их совсем нет времени читать, поэтому совмещаем приятное с полезным. Comics as Documentation частый гость на нашем канале, сегодня у нас и художница и программист Tomomi Imura c котиками и git-коммандами P.S Ну и пока мы на визуальной теме, предлагаю вам ознакомиться с серией скетч-заметой с недавней конференции Write the Docs Prague. Можете полистать эти заметки и так решить какой из докладов вам интереснее послушать/посмотреть (<-- тут ссылка на ютубный плейлист Пражской конфы) полностью: 1. Creating documentation for the African audience. 2. Toward the broader globalization of Open Source: documenting your localisation Journey 3. Improve Customer Adoption with UI Help 4. The Art of Asking Questions 5. Cultivating a Stakeholder Network for Our Docs: How Building Relationships Improves Our Content 6. Beyond spell checking - what else can we check automatically? 7. Documentation as Marketing? From Conflict to Collaboration 8. Maintaining Documentation: Make It Easy! 9. How I convinced my boss to build our docs team 10. ADHD and its impact on the Creative Process for Writers 11. Two years of Markdoc: what we’ve learned about balancing developer and author experience 🔗 Читать: GIT PURR! Git Commands Explained with Cats! #en #visual #example