Size: a a a

technicalwriters

2021 March 10

VI

Vladimir Izmalkov in technicalwriters
Александр Парень
Главное правило экранного текста
Абсолютно любые тексты на любых экранах - сайты, книги, инструкции, посты в бложеках - читаются лучше, если абзацы будут выделяться отдельной пустой строкой.
Сложно представить, сколько авторов потеряли своих читателей или даже просто не взлетели изначально только потому, что лепили все абзацы в верстальную сухомятку.
Сначала надо научиться делать два переноса после каждого абзаца, а потом садиться тексты писать.


Главное правило экранного текста

Абсолютно любые тексты на любых экранах - сайты, книги, инструкции, посты в бложеках - читаются лучше, если абзацы будут выделяться отдельной пустой строкой.

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

Сначала надо научиться делать два переноса после каждого абзаца, а потом садиться тексты писать.
Люблю я, когда забывают давно придуманное и начинают переизобретать велосипед. Тот же текст с выравниванием по ширине и отступом первой (красной) строки прекрасно читался бы и без пустых строчек имхо.
источник

НО

Наталья Орлова... in technicalwriters
Fox Mulder
Это читается ну очень плохо {визуально}.
Тут еще и с запятыми не все в порядке. У меня сразу доверие к таким поучительным текстам при наличии опечаток/ошибок резко падает в ноль.
источник

VI

Vladimir Izmalkov in technicalwriters
Maria Shabanova
Вчера смотрела сериал про пришельца и прям покайфовала от заставки) Она оформлена в виде инструкции
А что за сериал?
источник

MS

Maria Shabanova in technicalwriters
Vladimir Izmalkov
А что за сериал?
Засланец из космоса
источник

ЕК

Елена Коваленко... in technicalwriters
Добрый день! #wanted_tw  Технический писатель / Technical writer

Санкт-Петербург, Горьковская
Полная занятость, гибкий график

«Доктор Веб» исследует образцы вирусов со всего мира и постоянно обновляет программы для антивирусной защиты. Оперативно отражать изменения в документации и сохранять единообразие и красоту текстов при обновлении интерфейса — работа команды технических писателей. Для этой миссии мы ищем нового специалиста: хорошо пишущего на английском, технически подкованного, способного найти общий язык с разработчиками. Если вы можете всем этим похвастаться, у нас есть вакансия для вас.

Обязанности:
   разработка и обновление документации и текстов интерфейсов наших продуктов на русском и английском языках.

Требования:
   идеальная грамотность;
   свободное владение письменным английским языком;
   любовь к лаконичным и понятным интерфейсам;
   техническая грамотность.


Будет плюсом:
   опыт работы техническим писателем, копирайтером, редактором или переводчиком;
   опыт работы в IT;
   знание инструментария (XML-редакторы, CAT-инструменты, системы контроля версий);
   здоровая любознательность;
   высшее образование.

Условия:
   официальное трудоустройство;
   современный офис на Петроградской стороне;
   гибкий график работы;
   конкурентоспособную заработную плату (обсуждается индивидуально, зависит от вашего опыта и
   квалификации);
   ДМС, включая стоматологию;
   горячие обеды, фрукты, напитки;
   зону отдыха, тренажеры, полезные для работы книги.
Резюме ждем: https://company.drweb.ru/careers/peterburg
источник

IK

Ivan Kochurkin in technicalwriters
Fagor
Эта тема муссируется сотню лет. Нет, IDE для текста нет. И не планируется. Никто не видит рынок или стандарты, а значит не выгодно.

Так что максимум ide для кода с тонной плагинов и мелких сервисов/тулов уже на сервере, которые настроите сами. Да еще и язык разметки выбрать тип асидок, ямл, мд.
А у писателей из этого чата есть интерес к подобной IDE? Например, если бы условная JetBrains ее разработала (она славится своими качественными IDE для кода, но чисто для текста вроде ничего нет). Если да, то какие фичи самые приоритетные?
источник

IK

Ivan Kochurkin in technicalwriters
По мне так VSCode с тонной плагинов все же не очень юзабельно (они начинают тормозит, сам редактор не самый шустрый и этот блокнот все же больше ориентирован на программистов), IDE от JB с плагинами тоже не совсем то (тоже лишняя нагрузка на фичи, связанные с программированием). Но это мое имхо больше как прогера, про специализированные IDE не в курсе.
источник

H

Hartmann in technicalwriters
Ivan Kochurkin
По мне так VSCode с тонной плагинов все же не очень юзабельно (они начинают тормозит, сам редактор не самый шустрый и этот блокнот все же больше ориентирован на программистов), IDE от JB с плагинами тоже не совсем то (тоже лишняя нагрузка на фичи, связанные с программированием). Но это мое имхо больше как прогера, про специализированные IDE не в курсе.
Саблайм, плюс несколько специфических плагинов. Вполне себе пушка-игрушка.
Есть, кстати, Obsidian. Но он всё-таки md редактор, нежели всё остальное.
источник

A

AVDR in technicalwriters
Hartmann
Саблайм, плюс несколько специфических плагинов. Вполне себе пушка-игрушка.
Есть, кстати, Obsidian. Но он всё-таки md редактор, нежели всё остальное.
какие плагины к саблайму посоветуете?
источник

H

Hartmann in technicalwriters
Ну и ко всему прочему, Саблайм один раз купил и угомонился. А «любимые друзья» из JB зарядят подписочку и не постесняются.
источник

VI

Vladimir Izmalkov in technicalwriters
мне нравится Sublime
источник

H

Hartmann in technicalwriters
AVDR
какие плагины к саблайму посоветуете?
Названий уже не вспомню. Буду у машины гляну.
источник

H

Hartmann in technicalwriters
Vladimir Izmalkov
мне нравится Sublime
Да он лёгкий, мелкий и шустрый. Грех сетовать.
источник

KC

Kseniya Chudakova in technicalwriters
Люблю VSCode, опытным путём выявлены нужные плагины, поменяла терминал.
источник

NV

Nick Volynkin in technicalwriters
Mike Turchenkov
Коллеги, а нет ли в среде техписательства некой всеми используемой IDE, которая позволяла бы работать с текстом, как с кодом?
Чтобы, например, она запрещала использовать термины, предварительно их не импортнув из какой-нибудь уже готовой доменной модели данных?
И после компиляции в шапке каждого документа строилась бы автоматически таблица с перечнем используемых терминов и ссылками на места их определения?

Работал в latex, но какой сейчас передовой стек инструментов и технологий - очень хочу узнать.
Использую среды от JB и полностью ими доволен. То, что вы описываете — это скорее фичи не среды разработки, а языка разметки документации.

Термины в Sphinx-doc можно отдельно определять и потом ссылаться на них через :term:. Если сослались на несуществующий термин — будет ошибка сборки.
источник

FM

Fox Mulder in technicalwriters
Люблю VS Code.
Ну а тем временем рекомендую
https://www.youtube.com/watch?v=wWbDC1C7JEE
источник

H

Hartmann in technicalwriters
Kseniya Chudakova
Люблю VSCode, опытным путём выявлены нужные плагины, поменяла терминал.
Кстати, по поводу терминала. Нашёл для себя интересный, а именно Therm. Позволяет подключать дополнительные плагины, а также доступна возможность гибкой настойки, как визуальной части, так и прочего функционала «под капотом.» Последние несколько лет использую. Очень доволен. Единожды настроил и забыл. Огонь.
источник

FM

Fox Mulder in technicalwriters
Hartmann
Кстати, по поводу терминала. Нашёл для себя интересный, а именно Therm. Позволяет подключать дополнительные плагины, а также доступна возможность гибкой настойки, как визуальной части, так и прочего функционала «под капотом.» Последние несколько лет использую. Очень доволен. Единожды настроил и забыл. Огонь.
в вскоде я терминалю прямо из редактора.
источник

KC

Kseniya Chudakova in technicalwriters
Hartmann
Кстати, по поводу терминала. Нашёл для себя интересный, а именно Therm. Позволяет подключать дополнительные плагины, а также доступна возможность гибкой настойки, как визуальной части, так и прочего функционала «под капотом.» Последние несколько лет использую. Очень доволен. Единожды настроил и забыл. Огонь.
Ну вот я перешла на мак, поставила себе iTerm. Буду пробовать, вокруг все рекомендуют.
Но при этом продуктами JB тоже пользуюсь.
источник

VI

Vladimir Izmalkov in technicalwriters
Kseniya Chudakova
Ну вот я перешла на мак, поставила себе iTerm. Буду пробовать, вокруг все рекомендуют.
Но при этом продуктами JB тоже пользуюсь.
iTerm не идеален, но хорош, да
источник