Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости. Andrei Serikov in Технические писатели. Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна.
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. Я технический писатель, хотя в последнее время скорее knowledge manager. Станислав, вы описали самый отличный день технического писателя. Один или два параграфа о том, почему вы самый крутой писатель технических новостей в блоке. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь.
Газета.Ру в соцсетях
Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему.
Пока сделать перерыв и пойти выпить кофе. С кофе главное правило — не увлекаться.
Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет. Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание.
Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно.
Может быть, после некоторого размышления, он догадается, что все эти названия описывают одно и то же. Но мы же любим наших пользователей, зачем постоянно заставлять их решать подобные головоломки? Есть ещё одна важная особенность технических текстов: кроме правильного употребления общих терминов важны также фигуры описания. Так называются повторяющиеся фрагменты небольшого размера — словосочетания или короткие простые предложения. Например: «Функция … доступна в следующих режимах …» «Чтобы …, выполните в приложении … следующие действия: …» «Задайте системный параметр …» Для фигур описания иногда составляют отдельные словари или справочники. Казалось бы, мелочь. Но пользователь привыкает к определённым конструкциям и фразам. Если в одном месте документа написано «Выберите режим», а в другом «Перейдите в режим», у пользователя может возникнуть сомнения: здесь описано одно и то же действие или разные? Задача технического писателя — унифицировать весь тот зоопарк формулировок и терминов, которые употребляют в своих документах аналитики, разработчики и другие участники процесса разработки ПО.
У технических писателей обычно есть свои словари терминов и фигур описания.
Если коротко — почти любую техническую документацию. На самом деле, объём и типы документации от компании к компании могут сильно отличаться. Мануалы, инструкции, справочные материалы, FAQ по продуктам компании для конечных пользователей — это прямая обязанность. Спецификации, справочная информация для разработчиков, внутренняя документация для взаимодействия внутри команд и между ними, корпоративные базы знаний — не прямая обязанность, но часто перепадает именно на долю технического писателя или он как минимум всё это проверяет, упорядочивает и доводит до ума. UX-тексты подсказки, пункты меню, и т. Технические переводы с русского на иностранный и обратно — чаще всего именно задача техписа, но здесь есть нюанс с владением языками, поэтому нередко ему помогают переводчики особенно в мультиязычных компаниях.
Теодора Малевинская Держатель профессии «технический писатель» в Тинькофф О себе: Строю техписательские процессы для разработчиков, собираю редакции, развиваю профессиональное сообщество в компании и вне. Я очень люблю обращаться к статистике — это аргументы, которые я часто привожу: Исследование 1 В 2016 StackOverflow провёл исследование среди разработчиков о том, с какими проблемами они сталкиваются в работе. Исследователи делают вывод: «Это показывает как важно для компаний иметь хорошо написанную документацию». Исследование 3 Nintex проводили исследование о самых неэффективных процессах в ИТ-компаниях. Я сама наблюдаю, что часто такая проблема бывает из-за того, что какие-то ошибки или процессы не описаны в документации. Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний.
Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5. Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки. Что должен знать и уметь технический писатель? Это тоже зависит от компании, продукта и существующих задач, но мы с вами обратимся к Хабр Карьере и посмотрим, что требует рынок.
Есть почти во всех вакансиях в той или иной мере. В любом случае знание ГОСТ сильно облегчает работу и дарит навык структурирования. Навыки сбора и анализа информации. Навыки сбора и анализа, а также описания требований — да, с требованиями техническим писателям приходится работать часто, и там есть серьёзные нюансы сбора, агрегации и «просеивания» собранной информации. Способность работать структурировать, перерабатывать с большими объёмами информации — и с каждым годом всё больше. Аккуратность, внимание к деталям. Умение писать легко и понятно — пользователи разные, и информация должна быть доступная каждому.
Для работы требуются навыки делового общения как внутри организации, так и с заказчиками и исполнителями работ вне центра; работа в космической отрасли является преимуществом; Желательно обладать базовыми знаниями в области информационных технологий; Самоорганизованность, стрессоустойчивость. Работа в центре Москвы м.
366. День технической книги
Мультипликационный дебют мужчины состоялся во время его работы над картиной «Китай в огне». В данной картине впервые был использован альбомный метод мультипликации. В 1924-1925 годах художник занимался рисованием рекламных киноплакатов для таких фильмов, как «Девушка в маске», «Куртизанка», «Жена фараона» и многие другие. Достаточно известен плакат Сутеева к ленте «Веселые ребята» , который он создавал вместе с Дмитрием Бабиченко.
Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей.
С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала. В ряде городов СССР, например, в Минске, были созданы специальные кинотеатры «Новости дня» для демонстрации выпусков одноименного киножурнала.
Будем разбираться. Разработчики должны писать код, а не текст «Условие, что поле PART должно быть не пустым, обеспечивается целостностью процесса, заполняющего это поле, и не обеспечивается отдельным ограничением Oracle типа NOT NULL для обеспечения максимального быстродействия при изменении данных таблицы». Из внутренней документации проекта Бывает так, что программисты прекрасно разбираются в программе, досконально понимают все тонкости работы системы, но не могут красиво изложить всё это в текстовом виде.
Лично я убеждён, что в этом нет ничего плохого. Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических. Каждый должен заниматься своим делом.
Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы.
Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил. В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются.
Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления.
Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы.
Требования: - Опыт подготовки технической документации ГОСТ 19, ГОСТ 34 ; - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию; - Уверенное владение пакетом офисных приложений Word, Excel ; - Базовое понимание процессов разработки программного обеспечения. Контактные телефоны:.
День писателя
Опыт работы в аналогичной должности (или инженером – электроником) от одного года. Рассказываем о профессии технического писателя: обязанности, задачи, навыки, которые пригодятся для работы. Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». Иркутского Государственного Технического Университета ISSN. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева.
НОВОСТИ ДНЯ
Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. Новости дня читайте на Взгляде. Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года.
Навигация по записям
- Зачем нужны технические писатели – информатика тесты
- Кто такой технический писатель и чем он занимается
- Газета.Ру - последние новости, свежие события сегодня - Новости
- "Ахмат" в матче с "Пари НН" одержал третью победу в РПЛ подряд
- Поиск по сайту
С Днем технического писателя!
В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Должность: технический писатель, хотя в последнее время скорее knowledge manager. Я технический писатель, хотя в последнее время скорее knowledge manager. С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь.
День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. 5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей «TechWriter Days». Историю празднования Дня писателя узнают те, кто придет в библиотеку №107 (Перовское шоссе, д. 16/2).
#Кем стать: Техническим писателем
| TECHWRITER DAYS | Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна. |
| Всемирный день писателя | Отрадненский нефтяной техникум | Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. |
| Конференция TechWriter Days 05.04.2024 - 06.04.2024 | Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. |
5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева
Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других. Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов. Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли. Технический писатель должен сочетать в себе свойства технаря и гуманитария. Интерес к технике и программированию, усидчивость и внимательность должны в нём сочетаться с желанием осваивать новое и делиться своими знаниями. Очень важно знать предметную область, в которой ведется работа. Например, если вакансия открыта в ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта. Список ПО зависит от отрасли, в которой трудится специалист. Нужно уметь работать в команде, общаться с разработчиками и понимать пользователей, которые будут использовать продукт. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.
В некоторых IT-компаниях требуется, чтобы технический писатель знал языки разметки текста или один из языков программирования на уровне чтения кода, другим важны навыки работы с базами данных или в системах управления запросами. То, что пригодится точно — интерес к той сфере, о которой технический писатель работает. Некоторые работодатели требуют, чтобы образование у технического писателя было техническим. Другим нужно просто высшее образование. Еще одно требование — знание иностранного языка, потому лингвисты, филологи, переводчики тоже востребованы. Хорошо пишут тексты и коммуникабельны, как правило, выпускники гуманитарных направлений: литераторы, журналисты. Если человеку с таким образованием понравится разбираться в новой для себя области, то, скорее всего, ему подойдет эта профессия. Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают.
Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Кому нужен технический писатель. Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель. Технические писатели четким языком излагаю информацию. Большинство технических специалистов являются экспертами в своей области, они формируют описание продукта для равной себе аудитории. Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики — именно такой формат позволяет создать инструкцию, понятную всем участникам проекта.
Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации. Документация хорошего качества положительно влияет на продукт. Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию. Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле.
Фото: РИА Новости 189204 0 117 лет назад, 2 сентября 1906 года, в Акмолинске сегодня — Астана, столица Казахстана родился изобретатель, писатель-фантаст Александр Казанцев. После окончания Томского технологического института он работал инженером-механиком, но увлекшись изобретательством, перешел работать во Всесоюзный научно-исследовательский институт электромеханики. Когда Александру Казанцеву было 35 лет, началась Великая Отечественная война. В армии он служил заместителем командира саперного батальона, причем в звании рядового. Он предложил наладить выпуск для фронта дистанционно управляемых торпед-танкеток, его изобретение использовали во время прорыва блокады Ленинграда. Но самую ценную награду, именно за свою торпеду — специальную изобретательскую медаль, — я получил через полвека после войны», — рассказывал Александр Казанцев.
Иначе просто никак. Кошку зовут Фифа, смотреть в кадр она стесняется. Выглядываю в окно, там почему-то пасмурно, это странно, потому что вчера было безоблачно и ничего не предвещало беды. Пью чай с мятой и съедаю микроскопический бутербродик: 5. Одновременно смотрю погоду, сегодня у меня много "уличных" планов намечается. Погода теплая, но мокрая: 6. Пора выходить на пробежку. Время: 7. Это стадион, на котором чудесное резиновое наверное покрытие, бегать одно удовольствие. Возможно сейчас пойдет дождь, но я сильная! Я не пугаюсь 8. Срочно бегу в душ! Время: 10. Теперь можно полноценно позавтракать! Овсяная каша, огурец, помидор, хлеб и чай - радость для моего организма 11. Кошка тоже считаешь, что давно пора опять есть и составляет мне приятную компанию: 12. Завтрак поглощен, посуда помыта, кошка довольна, время: 13.
Контактные телефоны:.
Всемирный день писателя – 3 марта!
| Всемирный день писателя – 3 марта! | Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий. |
| День технического писателя: shamanidze — LiveJournal | Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». |