Technical Writing 101 🇺🇦

2022-08-18 15:48:55 Cегодня у нас в эфире тщательно подобранные материалы на почитать и профессионально развиться.

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

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

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

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

#book #en #resource #language #styleguide Открыть/Комментировать

2022-08-09 15:01:18 https://ifuckinghatejira.com/

#en #random Открыть/Комментировать

2022-08-01 16:06:43 После 4 лет работы, 75 альфа-версий и 22 бета-версий следующfя мажорная версия Docusaurus готова к продакшену.

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

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

Читать: Announcing Docusaurus 2.0

#en #SSG #tool #markdown

Technical Writing 101 Открыть/Комментировать

2022-07-28 16:45:23 shot-scraper — CLI тулза для для автоматического создания скриншотов веб-сайтов.

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

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

#en #tool #visual #screenshot

Technical Writing 101 Открыть/Комментировать

2022-07-20 16:20:00 У 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 Открыть/Комментировать

2022-07-12 16:49:02 Stripe заопенсорсили Markdoc. Markdoc — это authoring система на основе Markdown, на которой работает веб-сайт документации Stripe который мы все любим и ставим в пример каждый раз когда кто-то спрашивает примеры хорошей документации.

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

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

#tool #en #markdown #SSG Открыть/Комментировать

2022-07-04 19:45:24 Языки:

#ru | #en

Карьера:

#career — советы и всемозможные статьи о карьере техписателя
#conference — техписательские конференции, их записи и заметки
#resources — ресурс для саморазвития
#article — полезная статья, которая учит чему-то клёвому, что позволит стать более лучшим писателем
#vacancy — интересная вакансия или что-то связанное с наймом
#video — видео, видос, видосичек, видосюлька. И подкасты!
#book — книга/хендбук

Технологии:

#tool — полезная утилита/приложение
#changelog — все о чейнджлогах, примеры, правила
#markdown — все о языке разметки Markdown
#reStructuredText — все о языке разметки reStructuredText
#asciidoc — все о языке разметки asciidoc
#LaTeX — все систему набора и вёрстки и язык разметки LaTeX
#ide — среды разработки и все что с ними связано
#vscode — все о Visual Studio Code, настройка, плагины, хитрости
#SSG — JAMStack, генераторы статических сайтов, Hugo, Jekyll, Antora, etc.
#testthedocs — тестирование документации, линтинг
#API — про документирование API, примеры, лайфхаки, подсказки
#diagram — про диаграммы (много про diagrams as a code), mermaid, UML
#screenshot — все про скриншоты, утилиты, сервисы и красивенькие фотоснимки экрана
#ai — про GPT, GitHub Copilot и прочее, где ИИ помогает нам писать

Общее:

#tonevoice — о правилах общения в документации
#language — что-то конкретно о языке, в основном английский
#legal — юридическая документация, лицензии
#styleguide — все о стилях и правилах
#DocsAsCode — все про подход к документации как к коду
#example — примеры документации (хорошие и плохие)
#uiux — интерфейсы, текст в интерфейсах, пользовательский опыт
#knowledgemanagement — менеджмент знаний, хранилища, тулзы, техники, советы и наблюдения
#versioning — про версионирование
#accessibility — все об аксессебилити в документации
#checklist — чеклист/шпаргалка
#vintage — винтажная документация, старые компьютеры, софт, техника, игры
#visual — про визуальную составляющую документации
#metrics — все о метриках документации
#random — что-то совсем косвенно относящееся к техписательству, юморески

Предлагайте новые хэштеги в комментариях! Открыть/Комментировать

2022-07-04 19:44:32 Всем здрасьте!

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

Ну а теперь к новостям:

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

Я мощнейше запотел, но все же оформил какую-никакую навигацию по каналу, протегал по темам и языкам все вышедшие посты. В будущем буду обновлять пост с навигацией (предлагайте дополнительные хэштеги в комментариях!) . Он будет следующим после этого и всегда жить в шапке канала.

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

Логотип также претерпел небольших изменений, теперь мы используем модный хипстерский шрифт с лигатурами и вот этим вот всем (им же я пользуюсь при написании документации в IDE, чего и вам советую, шрифт - Fira Code). Открыть/Комментировать

2022-03-26 17:17:12 Доброго вечора, IT-спільнота, ми з України! Ситуація наступна: світу зараз як ніколи потрібні ви — вільні, працездатні, у безпеці.

До війни ми почали об'єднувати найдивовижніших, інноваційних людей України з метою створення неймовірних інноваційних продуктів. Тепер ми виходимо на новий рівень.
Ми хочемо надати вам роботу, офіс та житло. Ми хочемо знайти якнайбільше людей, які вірять, що майбутнє в їхніх руках.

Давайте зробимо світ кращим!

https://bit.ly/3qlBc8I Открыть/Комментировать

2022-03-14 13:53:51 В это пиздецовое непростое время многим моим согражданам Украинцам пришлось уехать из своих домов, покинуть свой город и даже страну. Некоторые заграничные заказчики ссыкливо отказываются от сотрудников Украине, бизнесы замораживаются или прекращают существовать. Многие потеряли не только дом, но и работу.

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

Во-первых, для всего этого есть отдельный сервис: UA Talents

Во-вторых: Вакансия —> Компания: Klarna. Локация: Берлин, Германия. Предлагают релокейшн-саппорт.

В-третьих: Вакансия —> Компания: Star. Локация: Wroclaw, Poland; Remote, EU Time Zone, Клиент из UK

UPD:

ДОБІРКА САЙТІВ З ПОШУКУ РОБОТИ:

https://helpukrainians.jooble.org
https://www.jobaidukraine.com
https://hireforukraine.org
https://www.jobs4ukraine.eu
https://remoteukraine.org
https://hrforukraine.notion.site

Подолаємо труднощі разом та переможемо Открыть/Комментировать