за профессионализм, признание професии и чистоту русского языка (и в технических документах тоже)! Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/. Самые свежие новости России и мира, новости политики, шоу-бизнеса. Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov.
День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Технические писатели. 3 марта отмечается Всемирный день писателя. Этот праздник был учрежден в 1986 году по решению конгресса Международного ПЕН-клуба, который был основан в Лондоне в 1921 году.
История профессии технического писателя
После обеда мне осталось дописать ещё несколько страниц. Перечитываю написанное и отправляю текст на согласование рецензентам. На этом этапе другие сотрудники рецензенты проверяют текст на понятность и верность изложения, а также при необходимости проверяют пунктуацию, синтаксис и структуру текста. Кроме описаний технический писатель также выполняет технологические задачи. Для этого необходимо хорошо знать инструменты для разработки и оформления документации.
Если вы с ними ранее не встречались, то на рабочем месте вы с легкостью их освоите. Во второй половине дня мне пришла задачка по сборке руководства пользователя в формат PDF. Совсем нет. Все элементарно и просто.
Доработали оформление, а там уже и вечер подступил. На этом мой рабочий день закончился. А завтра мне предстоит снимать видеоролики! Да-да, справка может быть не только текстовой и статичной, но и интерактивной.
Надеюсь, теперь вы отчасти представляете себе, кто такой технический писатель. А вы бы хотели им быть? Решайтесь и пробуйте!
Это мой первый обед, стараюсь делить прием пищи на два раза, так полезнее. Очень вкусно. Я снова за ноутом. После обеда, даже такого легкого, появилось желание поспать.
Нихт, арбайтен, архитектура сама себя не опишет. Хочу помощи зала. Пишу, рисую, разбираю рулбуки. Второй великий обеденный поход.
По правде говоря, было очень средне, обычно готовят намного вкуснее. Десять минут на обед, надо подготовиться к стендапу.
Ориентировочно мероприятие займёт 2 часа. Тема: «Инструменты технического писателя». Анастасия подготовила доклад «Создаём документацию с удовольствием в MadCap Flare», в котором она поделится своим многолетним опытом работы в MadCap Flare, а вы сможете задать ей любые вопросы.
Кстати, недавно в нашем блоге была статья Анастасии на эту тему. Далее технический директор компании «ПроТекст» Валерий Ледовской расскажет о средствах нашей работы: «Инструменты компании ПроТекст при выполнении задач технического перевода и локализации на аутсорсинге». Затем нам хотелось бы послушать рассказы самих участников об использовании разных инструментов, кроме самого распространённого варианта — Microsoft Word. Хотя если вы используете его каким-то необычным образом, мы тоже с удовольствием узнаем и о вашей практике! Готовьте рассказы, придумывайте вопросы для обсуждения, ибо круглый стол — это место для общения.
Приходите рассказывать и спрашивать, говорить и спорить, а не только слушать! Если вы подготовите презентацию, присылайте файл до начала встречи, и мы сможем оперативно подгрузить его в вебинар. Планы на будущее Также просим вас подумать, чего бы вы хотели от таких встреч — пишите свои предложения нам на адрес info protext.
Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям.
Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом.
В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный. Кроме того, сейчас я параллельно выступаю как бизнес- аналитик для небольшой команды разработки. Опыт техписа там тоже пригодился, потому что приходится много писать требования и другую проектную доку. Можно сказать, что прямо вот пишет технический писатель значительно меньше, чем собирает, анализирует, общается, уточняет. Очень дипломатичная профессия, в общем :- Вопросы, которые могли остаться Разве не лучше, если писать будут разработчики? Нет, не лучше, хотя часто именно так и происходит. Во-первых, это отнимает время разработчика, во-вторых, он не стремится сделать понятно, а пишет на своём языке, в-третьих, многие вещи ему кажутся простыми, понятными и очевидными и он не считает нужным даже упоминать их.
Между тем для пользователя такие мелочи могут оказаться дремучим лесом. А если технический писатель ошибся? Документация проходит контроль качества в отделе тестирования, как и весь комплекс программного обеспечения или инженерных решений. Однако всем свойственно ошибаться — и здесь уже компания оценивает критичность ошибки и выстраивает модель безопасности технической документации например, неправильно описанная функция в ERP-системе может не повлечь урон, а вот ошибка в мануале к банковскому или инженерному ПО может стоить слишком дорого. Технический писатель — это технический или писатель? И то и другое, поскольку это взаимодополняющие качества, делающие специалиста уникальным. Думается, что технические писатели — это одни из тех, кого долгое время не смогут заменить даже самые умные нейронки, поскольку за выдачей контента стоит огромная синтетическая и аналитическая работа, основанная на знании ПО, архитектуры и процессов.
ИИ это не под силу. Каков путь развития?
НОВОСТИ ДНЯ
| День технического писателя | Сталин и писатели. |
| День рождения инженера и писателя-фантаста | Победа РФ | Новость от 02.09.2023 | Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов. |
| Кто такой технический писатель и чем он занимается | Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. |
| День писателя | за профессионализм, признание професии и чистоту русского языка (и в технических документах тоже)! |
Зачем техписам конференции?
- 5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева
- Технический писатель - АО «Энергомера»
- 366. День технической книги: kraevushka — LiveJournal
- Новости | Центральная Библиотечная Система (ЦБС)
Военная операция на Украине
На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Кому нужен технический писатель.
Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель. Технические писатели четким языком излагаю информацию. Большинство технических специалистов являются экспертами в своей области, они формируют описание продукта для равной себе аудитории.
Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики — именно такой формат позволяет создать инструкцию, понятную всем участникам проекта. Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации.
Документация хорошего качества положительно влияет на продукт. Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию.
Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования. Устранив эти проблемы до релиза продукта, можно быть уверенным, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта.
Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами — это то, что большинство разработчиков никогда формально не изучали. Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода. Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя — писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта.
Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно — он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты. Даже если «этот снаружи» сидит в соседней команде. Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя.
Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен. Или к примеру, у меня в команде был такой разработчик, что он прекрасно пишет документацию и ему проще сделать это самому — вот такое у него хобби » Максим, директор департамента разработки ИТ-компании Какую карьеру может построить технический писатель? Технический писатель может выбрать для себя разные пути развития.
Очень многое зависит от проекта, над которым работает технический писатель. Если брать сферу IT, ближе всего к техническому писателю профессия бизнес-аналитика. Там требуются схожие качества: внимание к деталям, аналитический склад ума, стремление разложить все по полочкам. Из технического писателя получаются прекрасные специалисты по тестированию.
Когда Александру Казанцеву было 35 лет, началась Великая Отечественная война. В армии он служил заместителем командира саперного батальона, причем в звании рядового. Он предложил наладить выпуск для фронта дистанционно управляемых торпед-танкеток, его изобретение использовали во время прорыва блокады Ленинграда. Но самую ценную награду, именно за свою торпеду — специальную изобретательскую медаль, — я получил через полвека после войны», — рассказывал Александр Казанцев. Как писатель-фантаст Александр Казанцев дебютировал в 1936 году на конкурсе киносценариев. В соавторстве с Израилем Шапиро он написал сценарий фантастического фильма «Аренида» об астероиде, который грозит уничтожить Землю.
Выглядываю в окно, там почему-то пасмурно, это странно, потому что вчера было безоблачно и ничего не предвещало беды. Пью чай с мятой и съедаю микроскопический бутербродик: 5. Одновременно смотрю погоду, сегодня у меня много "уличных" планов намечается. Погода теплая, но мокрая: 6. Пора выходить на пробежку. Время: 7. Это стадион, на котором чудесное резиновое наверное покрытие, бегать одно удовольствие. Возможно сейчас пойдет дождь, но я сильная!
Я не пугаюсь 8. Срочно бегу в душ! Время: 10. Теперь можно полноценно позавтракать! Овсяная каша, огурец, помидор, хлеб и чай - радость для моего организма 11. Кошка тоже считаешь, что давно пора опять есть и составляет мне приятную компанию: 12. Завтрак поглощен, посуда помыта, кошка довольна, время: 13. До выхода из дома осталось чуть меньше двух часов, надо срочно позаниматься за фортепиано, а погодка кстати налаживается, выглядывает солнышко.
Может быть, синоптики обманули нас с дождем?
Поселю в нее людей, дорогих моему сердцу. Рожайте детей и растите хлеб. Так было всегда и так будет до скончания века».
На страницах этой книги вы познакомитесь со всеми жителями небольшой деревеньки, в которой провел свое детство будущий писатель. В 2002 году выходит в свет сборник рассказов «Полынья». Истории, рассказанные писателем просты. Но в каждой истории главный герой через жизненные испытания, муки совести обретает духовную свободу.
За эту книгу Владимир Николаевич становится лауреатом литературной премии Нижний Новгород. Известный нижегородский писатель Валерий Шамшурин так сказал о нем: «Если вы спросите меня - какую книгу читать всей семьей? Я отвечу - откройте книгу "След облака". Перед вами предстанет мир бесконечно узнаваемый, но исполненный величия и значения.
Вашими собеседниками станут простые русские люди с непростым духовным миром, с умением жить несмотря ни на что и видеть красоту мира.
366. День технической книги
Познакомились с книгой и посмотрели мультфильм о приключениях необыкновенной собачки Сони, которая очень любит думать. Юные участники мероприятия с удовольствием отгадывали загадки, внимательно слушали стихи и песни в исполнении самого Андрея Усачёва и сами рассказывали его стихи. После мероприятия ребята с интересом рассматривали книги, принесённые библиотекарем.
Так он подписаны первые, начала 1920-х годов, поэтические сборники «Гроздь», «Горний путь» и который сохранился вплоть до конца 1930-х. В обиходе семьи Набокова использовалось три языка: русский, английский и французский. По собственным словам, он научился читать по-английски прежде, чем по-русски. Будучи лепидоптерологом Владимир Набоков открыл двадцать новых видов бабочек, а его произведения насчитывают 570 упоминаний различных видов бабочек.
В честь писателя были названы свыше 20 видов бабочек и род бабочек Nabokovia. Коллекцию бабочек в 4324 экземпляра после смерти Набокова его жена Вера подарила университету Лозанны. В шестидесятых и семидесятых годах Набоков последовательно отказывался от всевозможных предлагавшихся ему почетных титулов и состоял лишь в Обществе лепидоптерологов — регулярно платя членские взносы, но не желая, чтобы его имя значилось в списке членов. В 1985 году именем Набокова был назван астероид. Набоков отлично играл в шахматы и написал даже несколько собственных сложных шахматных задач.
Она вручается ежегодно с 1996 года за лучшее прозаическое произведение на английском языке. Наиболее экранизируемым писателям является Эдгар По. Сюжеты произведений этого американского писателя вошли в 114 кинофильмов. В Великобритании писательница Агата Кристи считается одним из символов страны и почитается наравне с королевой. Тираж ее произведений уступает только Шекспиру и Библии. О профессии писателя Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными. Писатели должны хорошо владеть языком и обладать индивидуальным стилем. Люди, которые хотят посвятить себя писательству, учатся в ВУЗах на филологических и гуманитарных факультетах.
В тот раз все обошлось, поскольку секунданты зарядили пистолеты клюквой вместо пуль. У Льва Толстого был очень неразборчивый подчерк. Чтобы издатели смогли напечатать его произведения, жена и дочь вынуждены были переписывать рукописи. День писателя — праздник творческих людей и, как правило, проходит красиво и торжественно.
Все новости
С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. Специальность технический писатель появилась не так давно, однако уже является востребованной.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. Иркутского Государственного Технического Университета ISSN.
НОВОСТИ ДНЯ
Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси.
#Кем стать: Техническим писателем
Для работы требуются навыки делового общения как внутри организации, так и с заказчиками и исполнителями работ вне центра; работа в космической отрасли является преимуществом; Желательно обладать базовыми знаниями в области информационных технологий; Самоорганизованность, стрессоустойчивость. Работа в центре Москвы м.
Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы.
Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано. Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений. Обычно это списки из пар «Название поля — описание». Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет. Но, к сожалению, так бывает редко.
Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз».
Сразу иду в столовую, чтобы не терять время. Манная каша, пудинг и черный чай с молоком. Вот такой стандартный набор. Первым делом проверяю рабочую почту, потом планирую фронт работ. Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге. Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance.
Реформатор сцены, автор 47 оригинальных сочинений, создатель русского национального театра, его пьесы всё так же популярны и с успехом идут в современных театрах. Центральная районная детская библиотека совместно с 7 «Б» классом Шипицынской средней общеобразовательной школы приняли участие в акции. Ребята познакомились с биографией писателя. Узнали интересные факты из его жизни.
TechWriter Days
Опыт работы в качестве технического писателя в области разработки и внедрения информационных систем от 3х лет. Служба безопасности День. Табло. Глобалисты провоцируют жёсткие санкции. Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя.