Type to search
Advanced channel search

Airdrop Alert Worth 2000 USD

Each winner will be airdropped a 20 USDT bonus
img
ad

SearcheeBot

Your guide in the world of telegram channels
img
ad

TGAlertsBot

Monitoring of keywords in channels and chats
img
ad

Technical Writing 101 🇺🇦

@technical_writing
Channel's geo and language: Ukraine, Russian
Category: Technologies

Anything's A Documentation If You're Brave Enough
👋 @SuckMyNuts

Related channels
Channel's geo and language
Ukraine, Russian
Category
Technologies
Statistics
Is this your channel? Confirm Channel history
Posts filter

Technical Writing 101 🇺🇦

27 Jan 2023, 18:33

Open in Telegram Share Report
environmental documentation
3.8k 0 17 4 39
Technical Writing 101 🇺🇦

23 Dec 2022, 21:02

Open in Telegram Share Report
Есть чувство, шо GitHub вот-вот перевернет рэп игру своей новой функцией Blocks.

Blocks ー переосмысление того, как мы смотрим на репозитории. Blocks предлагают сделать репозитории с кодом интерактивными, что-то на подобие Colab Notebooks.

Среди уже показанных фишек:

➡️ Встраивание интерактивных-демо-блоков с кусками рабочего приложения вместо скриншотов;
➡️ Создание справочной документации с возможностью поиска по ней (встроенный SwaggerUI anyone?);
➡️ Визуализация и возможность сортировать, ворочать туда-сюда CSV и JSON как эксельку в гуглодоках;
➡️ Редактирование и встраивание диаграм опять же, интерактивным блоком прямо в документации.

Это всего лишь несколько функций, которые релевантны для технических писателей, но на деле все намного интереснее и круче. Крайне рекомендую перейти по ссылочке и ознакомиться самостоятельно.

Бонус треком GitHub представил проект TestPilot ー искуственный интеллект, который пишет за вас юнит тесты, основываясь на документации и уже существующем коде. Еще +1 повод содержать свою документацию в порядке.

🔗 Срочно читать: GitHub Blocks Technical Preview: Reimagine repositories
4.2k 0 27 4 14
Technical Writing 101 🇺🇦

22 Dec 2022, 16:28

Open in Telegram Share Report
Допомоги/Підтримки пост

Гайз, хочемо поділитись з вами штучним інтелектом який може створити унікальне зображення чого завгодно, в будь-якому стилі, треба просто описати це за допомогою тексту 📝
Чим докладніше опис - тим краще😉

P.S. частина коштів йде на допомогу бійцям полку 3 штурмової бригади.💙💛

P.P.S Картинка згенерована по запиту "A person writing a post for technical writing blog", seems close enough
3.4k 0 7 22
Technical Writing 101 🇺🇦

12 Dec 2022, 17:25

Open in Telegram Share Report
В дев-комьюнити ReadME, который хостит GitHub, вышел годный пост про ведение рабочих заметок.

В этом блогпосте рассматривается важность документирования знаний посредством вдумчивого ведения заметок и то, как построение командной культуры на основе этой практики может улучшить коллективное понимание.

Применяя такой подход к ведению заметок, команды легко алайнятся в совместной работе и находятся "on the same page" в плане понимания важной информации и идей.

🔗 Читать: Documenting knowledge: a guide to successful note-taking
3k 0 27 12
Technical Writing 101 🇺🇦

16 Nov 2022, 19:30

Open in Telegram Share Report
У Ноушна намечается что-то очень интересное! Бойтесь, писатели, оно уже пишет всё за нас!

Минутная видео-презентация по ссылочке.

👀 Смотреть: Introducing Notion AI
3k 0 18 3 7
Technical Writing 101 🇺🇦

15 Nov 2022, 16:21

Open in Telegram Share Report
Ну штош, будем попробовать.

Без поддержки Asciidoc не так интересно, как хотелось бы, но все еще хз даже чего ожидать
2.7k 0 1 2 10
Technical Writing 101 🇺🇦

9 Nov 2022, 13:21

Open in Telegram Share Report
Зарелезилась популярная платформа для документации 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
2.8k 0 20 14
Technical Writing 101 🇺🇦

8 Nov 2022, 16:33

Open in Telegram Share Report
📕 Хороший, годный тред на Хакерньюс, где пользователи ресурса делятся полезными и популярными книгами про техрайтинг, в комментах можно найти ссылочки на аналогичные треды, где контентика еще больше. Выцеживать оттуда ссылки мне откровенно лениво, поэтому наслаждайтесь as is, годных советов там валом.

🔗 Читать: Ask HN: Any great books about technical writing?

#book #resource #career #en
2.2k 0 38 31
Technical Writing 101 🇺🇦

14 Oct 2022, 19:20

Open in Telegram Share Report
Интересно наблюдать за разным ходом мысли в решении схожих проблем.
👁___👁

Разработчики Han Wang и Hahnbee Lee радикально подошли к поддержанию документации в актуальном состоянии. Теперь ссылку на документацияю можно натурально прибить гвоздями в IDE (VSCode) и получать уведомления в реальном времени, мол, обнови документацию после изменения кода.

Как это выглядит на практике - можно ознакомиться в этом видео.

В данный момент "прибитие гвоздями" поддерживается в следующих сервисах:
- Notion
- Google Docs
- Confluence
- GitHub
- Slack

🔗 Скачать: Mintlify Connector

#tool #en #vscode #ide
2.6k 0 29 15
Technical Writing 101 🇺🇦

4 Oct 2022, 15:14

Open in Telegram Share Report
Редакция очень любит комиксы, хоть в последнее время их совсем нет времени читать, поэтому совмещаем приятное с полезным.

Comics as Documentation частый гость на нашем канале, сегодня у нас и художница и программист Tomomi Imura c котиками и git-коммандами

P.S Ну и пока мы на визуальной теме, предлагаю вам ознакомиться с серией скетч-заметой с недавней конференции Write the Docs Prague. Можете полистать эти заметки и так решить какой из докладов вам интереснее послушать/посмотреть (
2.5k 0 22 2 22
Technical Writing 101 🇺🇦

22 Sep 2022, 16:47

Open in Telegram Share Report
В Slack добавляется функционал редактирования/создания документов. Компания, принадлежащая Salesforce, объявила сегодня на своей конференции разработчиков, что она создает новую функцию под названием Canvas, которая позволит пользователям создавать и редактировать полноценные документы прямо из интерфейса Slack.

Как это выглядит и работает можно глянуть в статья на The Verge или официальном блоге компании

🔗 Читать: Your digital HQ just got better with Slack canvas

#en #tool
2.2k 0 9 5 7
Technical Writing 101 🇺🇦

13 Sep 2022, 16:51

Open in Telegram Share Report
Сейчас проходит (подходит к концу) Write The Docs Prague, конференция для технических писателей с кучей интересных докладов.

С расписанием можно ознакомиться тут. А сами доклады и заметки из них я постараюсь опубликовать чуть позже.

Доклады на которые я хочу обратить внимание:

1. Beyond spell checking - what else can we check automatically?
2. Maintaining Documentation: Make It Easy!
3. How I convinced my boss to build our docs team

Если вам не терпится ознакомиться с заметками и вообще пронаблюдать как проходит конференция - WTD Twitter
2.5k 1 21 5 27
Technical Writing 101 🇺🇦

2 Sep 2022, 13:53

Open in Telegram Share Report
JetBrains в очередной раз очень сытно тизернули фичи грядущей IDE для технических писателей Writerside.

В этот раз — в самое сердечко, показали как работает встроенное тестирование документации: валидность разметки, целостность оглавления, ссылки и референсы, отпавшие картинки.

Не так давно я усиленно начал работать с AsciiDoc и решил, в виду более фичастого плагина, попробовать вернуться на WebStorm. И имею сказать, что забираю все претензии, которые имел к нему. За последние 4 или 5 лет, сколько я им не пользовался, вебшторм и все причастное к написанию в нем документации выросло до небывалых высот. Перешел с vscode и markdown на asciidoc+antora и webstorm, и не знаю бед.

В будущем канал сменит вектор с около-markdown штуковин и тулз на, как мне кажется, более зрелый и взрослый asciidoc, это моя новая любимая игрушка.

#markdown #asciidoc #tool #en #testthedocs
3.4k 3 34 9 24
Technical Writing 101 🇺🇦

1 Sep 2022, 17:49

Open in Telegram Share Report
Писать по предложению на каждой строчке оказалось довольной удобной техникой.

Крайне полезно при переписывании за кем-то (или за собой) текстов, предложения без смысла находятся очень легко.

Статья сжато и понятно описывает все преимущества такой техники. Современные языки разметки (md,adoc) буквально нативно позволяют это делать не разрывая строку при последующей сборке html/pdf, и т.д). Попробуйте!


➡️Читать: Writing One Sentence Per Line

#en #article
1.9k 1 17 3 19
Technical Writing 101 🇺🇦

18 Aug 2022, 15:48

Open in Telegram Share Report
Cегодня у нас в эфире тщательно подобранные материалы на почитать и профессионально развиться.

В подборке собрано очень много годного материала, начиная от базовых советов, заканчивая оксфордскими книжками по языку.

Если вы давно думали чего бы такого читнуть, чтобы стать лучше, как писатель - this is it.

Советую проклацать прямо по всем ссылочкам, узнал много нового даже из залинкованных вики-статей 👍

📖 Читать: Technical Writing: a bibliography, tips, and tricks

#book #en #resource #language #styleguide
2.5k 0 45 4 23
Technical Writing 101 🇺🇦

9 Aug 2022, 15:01

Open in Telegram Share Report
2.3k 0 16 1 15
Technical Writing 101 🇺🇦

1 Aug 2022, 16:06

Open in Telegram Share Report
После 4 лет работы, 75 альфа-версий и 22 бета-версий следующfя мажорная версия Docusaurus готова к продакшену.

Из главных новшеств:
- Поддержка MDX: позволяет интегрировать интерактивные React компоненты прямо в документации. Пример
- Плагины: Docusaurus теперь имеет модульную архитектуру с системой плагинов. Основные функции, такие как документация, блог, страницы и поиск, работают как отдельные плагины. Доступны дополнительные плагины, например docusaurus-search-local, как замена Algolia. Больше плагинов тут
- Поддержка PWA
- Удобное версионирование документации

С более мелкими улучшениями можно ознакомиться в официальном блог посте

Читать: Announcing Docusaurus 2.0

#en #SSG #tool #markdown

Technical Writing 101
2.6k 0 14 8 17
Technical Writing 101 🇺🇦

28 Jul 2022, 16:45

Open in Telegram Share Report
shot-scraper — CLI тулза для для автоматического создания скриншотов веб-сайтов.

shot-scraper помогает автоматизировать создание свежих скринов веб-приложений (можно скринить конкретную часть приложения/сайта) для последующей интеграции в документацию, чтобы визуал не отставал от контента. Можно засунуть в CI\CD и всякое такое.

Бонусом у утилиты отличная документация и два [1]блог [2]поста которые рассказывют как всем этим пользоваться, и зачем, и как это создавалось.

#en #tool #visual #screenshot

Technical Writing 101
2.6k 0 44 1 26
Technical Writing 101 🇺🇦

20 Jul 2022, 16:20

Open in Telegram Share Report
У New Relic довольно неплохой стайлгайд по написанию документации. Отдельно хочу обратить внимание на 5 вопросов, которые авторы стайлгайда предлагают задать себе, чтобы понять то ли ты вообще делаешь.

Следующая секция стайлгайда “Writing inclusive content” учит как не ненароком не обидеть своего читателя. Она довольно базовая, поэтому предлагаю взглянуть на отдельную статью про настройку своего линтера, которая помогает как раз находить такие узкие места в вашей документации.

Читать:
[1] New Relic Style Guide + 5 questions
[2] Reducing negative and biased language in documentation

#testthedocs #styleguide #voicetone #en #tool #language
2.4k 1 56 36
Technical Writing 101 🇺🇦

12 Jul 2022, 16:49

Open in Telegram Share Report
Stripe заопенсорсили Markdoc. Markdoc — это authoring система на основе Markdown, на которой работает веб-сайт документации Stripe который мы все любим и ставим в пример каждый раз когда кто-то спрашивает примеры хорошей документации.

Markdoc подходит как для обычных статических сайтиков, так и для фичастых сайтов с документацией или личных блогов.

Stripe подготовили довольно неплохую документацию, интерактивный плейграунд и несколько статеек о начале работы с Markdoc и даже о создании простого плагина.

#tool #en #markdown #SSG
2.7k 0 48 3 36
20 last posts shown.

1 592

subscribers
Channel statistics