Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. девушка при исполнении, а в свободное время - поэт. Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть.
TECHWRITER DAYS
Поздравляем всех технических писателей страны с профессиональным праздником и желаем нескучных рабочих будней, отличного настроения и благодарных пользователей! Мы ищем технического писателя в команду Indeed Access Manager. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области.
: техническим писателем ✒
Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Поэтому какое-то время мечтала стать писателем. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN.
«День с писателем».
Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области.
Новости дня
Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов.
Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно. Может быть, после некоторого размышления, он догадается, что все эти названия описывают одно и то же. Но мы же любим наших пользователей, зачем постоянно заставлять их решать подобные головоломки? Есть ещё одна важная особенность технических текстов: кроме правильного употребления общих терминов важны также фигуры описания. Так называются повторяющиеся фрагменты небольшого размера — словосочетания или короткие простые предложения.
Например: «Функция … доступна в следующих режимах …» «Чтобы …, выполните в приложении … следующие действия: …» «Задайте системный параметр …» Для фигур описания иногда составляют отдельные словари или справочники. Казалось бы, мелочь. Но пользователь привыкает к определённым конструкциям и фразам. Если в одном месте документа написано «Выберите режим», а в другом «Перейдите в режим», у пользователя может возникнуть сомнения: здесь описано одно и то же действие или разные? Задача технического писателя — унифицировать весь тот зоопарк формулировок и терминов, которые употребляют в своих документах аналитики, разработчики и другие участники процесса разработки ПО. У технических писателей обычно есть свои словари терминов и фигур описания. Опытный писатель разбирается в системе и понимает, что именно означает тот или иной жаргонный термин во внутреннем документе.
Вратарь разработки Технический писатель — лучший гуманитарий среди технарей и лучший технарь среди гуманитариев. Михаил Острогорский Выходит, что технические писатели в пользовательской документации исправляют все недостатки, ошибки и неточности, допущенные во внутренней документации и метаданных в процессе проектирования и разработки системы. Это тот самый рубеж, на котором «баг» то есть «изъян» волшебным образом превращается в «фичу», а «велосипеды» и «подпорки» — в стройную архитектурную схему из красивых разноцветных прямоугольников. Как известно, программист — это не тот, кто пишет программы, а тот, чьи программы работают.
Теперь соискатели видят 1 отзыв. Вы получили статус «Открытый работодатель»","employerReviews. Кандидаты увидят ответы на hh. Воспользуйтесь шаблоном — его можно редактировать. Что это даст? Попросите лояльных сотрудников конструктивно написать, что им нравится в компании и что можно улучшить.
Демонстрировался в кинотеатрах перед киносеансами. Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы.
Ключевые направления деятельности: системная интеграция, производство телекоммуникационного оборудования и ПО, разработка системы автоматического распознавания лиц и научно-исследовательская деятельность. По итогам 2018 г.
: техническим писателем ✒
Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики — именно такой формат позволяет создать инструкцию, понятную всем участникам проекта. Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации. Документация хорошего качества положительно влияет на продукт. Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию. Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования.
Устранив эти проблемы до релиза продукта, можно быть уверенным, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта. Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами — это то, что большинство разработчиков никогда формально не изучали. Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода. Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя — писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно — он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты. Даже если «этот снаружи» сидит в соседней команде.
Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя. Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен. Или к примеру, у меня в команде был такой разработчик, что он прекрасно пишет документацию и ему проще сделать это самому — вот такое у него хобби » Максим, директор департамента разработки ИТ-компании Какую карьеру может построить технический писатель? Технический писатель может выбрать для себя разные пути развития. Очень многое зависит от проекта, над которым работает технический писатель. Если брать сферу IT, ближе всего к техническому писателю профессия бизнес-аналитика. Там требуются схожие качества: внимание к деталям, аналитический склад ума, стремление разложить все по полочкам. Из технического писателя получаются прекрасные специалисты по тестированию.
Технический писатель может стать менеджером проектов, попробовать себя в тестировании. Если человек писал много документации о программах на Java, заинтересовался и решил изучить этот язык программирования, он может стать разработчиком. Некоторые технические писатели уходят в сферу маркетинга или продаж, особенное если это направление по продвижению IT-продуктов: умение структурировать информацию и наглядно представлять её помогает готовить презентации для потенциальных клиентов, а умение понимать нужды клиента или пользователя, предугадывать его вопросы, незаменимо в этой области. Многие технические писатели предпочитают работать на различных проектах: являясь фрилансерами, они вольны выбирать для себя наиболее интересные проекты, совершенствуя свои навыки в разных направлениях. Развиваясь, они становятся незаменимыми специалистами на биржах по поиску специалистов. Это интересно как самому техническому писателю, так и работодателю: специалист задействован на определенные задачи и трудовых отношений часто не возникает. Я всегда мечтала путешествовать, поэтому очень много время уделяла изучению иностранных языков. Журналистика не пошла, хотя очень нравилось писать технические тексты. Знакомые предложили попробовать себя в IT — необходимо было разобраться с высокотехнологичным продуктом в помощь основному техническому писателю.
Но у нас есть много других похожих вакансий, которые могут Вас заинтересовать. Показать описание вакансии Обязанности: Разработка сетевых графиков проектов, конструкторской и эксплуатационной документации, схем, маршрутных карт и другой технической документации, внесение изменений в техническую документацию в связи с корректировкой; Разработка конструкторской и эксплуатационной документации; Ведение переписки с заказчиком и исполнителями составной части опытно-конструкторской работы, документооборот; контроль сроков выполнения работ по договорам; участие в ведении архива документации учёт, регистрация, выдача, копирование, актуализация ; участие в совещаниях по направлениям разработки и сопровождения инфраструктуры; Отчётность по договорной работе. Умение вести документооборот, знание в области ведения контрактной работы; умение быстро включаться в работу, адекватно воспринимать задачи и выполнять их в указанные сроки; Знание нормативной докуметации по ГОСТ 19, 34 желательно с применением на практике.
У Льва Толстого был очень неразборчивый подчерк. Чтобы издатели смогли напечатать его произведения, жена и дочь вынуждены были переписывать рукописи. День писателя — праздник творческих людей и, как правило, проходит красиво и торжественно. По всей России в этот день организуются культурные мероприятия, концерты, семинары, слеты авторов и публицистов.
Поэтому невозможно физически договориться о том, что мы сегодня не успели и сделаем завтра. Если срок сдачи документа — 30 сентября, то не позднее этого дня он должен быть любой ценой. Но при этом вариативность типа личности, которому подходит карьера технического писателя, велика. Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики. Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит. Предположим, в компании открыто несколько вакансий технических писателей на разные проекты. Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов. Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы. Например, пояснительную записку на 1000 страниц с техническими подробностями. Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст. Типаж 2 — «решала» Проект Б. На проекте много согласующих, но несложная документация. Не требуется глубоко лезть в технические вещи. На этом проекте, чтобы согласовать небольшую стопку документов, нужно встретиться с заказчиками и с 5-6 людьми договориться, понять, что они хотят, найти к каждому подход. Поэтому на этот проект нужен своеобразный «решала» — человек, который умеет договариваться, нравиться людям и находить компромиссы. Типаж 3 — «бодала» Проект В. На этом проекте непростое согласование документов, потому что со стороны заказчика есть люди, у которых свое представление о прекрасном. Нет широкого поля для коммуникаций, нет глобальных технических сложностей, но тут, находясь в одной связке с заказчиком, надо уметь отстаивать свои интересы. Человек, работающий на этом проекте, должен уметь работать в одной команде с заказчиком, но при этом «бодаться» — защищать свое мнение. Выводы Технический писатель в IT — это полноценный член проектной команды. Он взаимодействует со всеми участниками и напрямую отвечает за успех проекта. У технического писателя есть конкретные зоны роста, помимо создания технической документации — это менеджмент, аналитика и юриспруденция. Технический писатель может расти как горизонтально, так и горизонтально-вертикально, так и вертикально. Не нужно сильно привязываться к софт-скилам. Они могут сильно отличаться в зависимости от типа проекта, на который ищут техписа. Если вы библиотечный бука и не любите общаться — вы найдете работу. Если вы легкий на подъем, сильный в коммуникациях человек, но устаете от рутинной работы — вы тоже найдете работу. Хард-скилы также могут сильно отличаться и зависят от проекта. Бывает, что нужен продвинутый техпис-аналитик, под конкретный проект с конкретным стеком технологий. И хард-скилы — это то, что легче прокачать, в отличие от софтов. Прямо сейчас у нас открыт набор технических писателей в нашу команду!
Военная операция на Украине
Один или два параграфа о том, почему вы самый крутой писатель технических новостей в блоке. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. «Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть. Известный нижегородский писатель Валерий Шамшурин так сказал о нем.
С Днем технического писателя!
Как-то кошка отказалась есть и писать — немедленно вылетела с ней к вету, а оказалось, что этой скотине надоели паучи и она хотела сушки. Как только в клинике насыпали сухого корма, начала лопать за обе щеки. Платили вместе с мужем. Мужу в этом году подарю переезд в Алматы, хе-хе-хе. Когда сын будет жить один, планирую переводить деньги по мере необходимости: на карманные, на еду, на квартплату, на дополнительные расходы. Одежду мы заказываем на «Вайлдберриз», это оплачивается с моей карты. Репетиторов и прочее я тоже оплачиваю сама. В остальных категориях расходов все по-прежнему, как в предыдущем дневнике. В плане ведения бюджета тоже ничего не изменилось.
День из жизни 03:00. Просыпаюсь в снятой посуточно квартире. Где-то наверху рыдает ребенок, судя по выговору, лет полутора-двух. И родители бедолаги. Засыпаю, поболтав в «Телеге» с сыном. Мы оба очень болезненно переживаем разлуку. Но наши психотерапевты убеждают, что стоит попробовать пожить раздельно, к тому же это всегда можно откатить назад. Плюс я постоянно на связи и есть те, кто может помочь сыну в Питере.
Соответствующие доверенности оформлены. Снова просыпаюсь. К 11 надо идти подписывать договор аренды: нашла съемную квартиру семье. Всю неделю здесь занимаюсь делами, что, в общем, ожидаемо. То, се, пятое, десятое. Сделала симку вот, оформила карту Kaspi. Kaspi в Казахстане есть у всех — очень удобно: пополняешь ее со своего счета и платишь ею хоть переводом по телефону, хоть через QR-код. Ну и бегала, смотрела квартиры.
С ними все непросто. Коллеги подсказали, что лучше смотреть в районе Театра драмы имени Ауэзова. А там либо небольшие панельки, либо новостройки, причем многие — формата «дворец»: с хрусталем, коврами, диванищами. У нас же были требования: чтобы документы квартиры были в порядке и мы могли оформить РВП, чтобы в ней были кондиционер, посудомойка, три комнаты с возможностью установить рабочие столы. В итоге в основном подходили как раз новостройки. Платить за съем предполагалось из релокационного бюджета компании, а в него новостройки пролезали — я, соответственно, смотрела их. Я выбрала квартиру с обставленной детской для дочери и большой спальней для нас с мужем. Сына, когда приедет в гости, можно будет положить в гостиной.
А куда воткнуть столы, потом придумаю. Эту квартиру риелтор нашла мне случайно: мы смотрели другую рядом, а она не подошла, и риелтор вспомнила, что есть еще одна. Из наших требований здесь нет посудомойки, зато есть джакузи. Дочь будет счастлива: она обожает принимать ванну. Муж говорит, что будем мыть посуду в джакузи. Лениво восстаю, ползу приводить себя в порядок — душ, зубы, все такое. Есть не хочется — позавтракаю, когда все сделаю. Сажусь за комп, приходит идея по работе, вношу правки в статью.
Звонит риелтор. Они с хозяйкой на месте — не могу ли я прийти пораньше?
С ними технический писатель обсуждает логику создания продукта, которую те придумали для разработчиков. Иногда совместно с аналитиками технический писатель может создавать документацию для команды разработки. Взаимодействие с дизайнерами нужно для того, чтобы задокументировать те или иные решения по дизайну. Руководители проектов. С РП технический писатель взаимодействует для координации и контроля над соблюдением всех необходимых формальностей со стороны участников проекта. Обеспечивает консистентность формальной части проекта. Цели работы технического писателя Работа в сфере заказной разработки — это командный вид спорта, поэтому цель работы технического писателя — это успех всей команды, всего проекта.
Антицель — написать красивый документ по ГОСТу, по которому невозможно провести испытания демонстрацию продукта заказчику , либо который не коррелируется с разработанной функциональностью продукта. Поэтому технический писатель разрабатывает документацию для целей, которые должны совпадать с целями компании. Если он пишет отчетную документацию по конкретному проекту, то он должен тесно взаимодействовать с проектной командой и осознавать, что разработанная функциональность будет приниматься заказчиком именно на основе написанной им отчетной документации. А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ. Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним. Если клиенту что-то не нравится — выяснить, что именно, и понять, как это исправить. Куда расти техническому писателю Представим ситуацию, что человек приходит на позицию технического писателя, перерастает грейд Junior и в какой-то момент начинает думать: «А куда дальше развиваться?
Буду ли я до конца карьеры писать технические документы, такие как руководство пользователя? У технического писателя есть конкретные зоны роста — как горизонтального, так и вертикального. Поговорим о горизонтальном росте подробнее. Хороший технический писатель должен знать, какие шаги нужно пройти для успешной сдачи проекта. Это шаги, которые находятся не только в его компетенции, но и которые должны пройти другие участники команды: дизайнеры — нарисовать макеты, разработчики — написать код, аналитики — описать бизнес-процессы. И контроль выполнения работ другими участниками команды тоже может быть в числе обязанностей техписа. Также техпис должен уметь оценивать затраты на разработку той или иной документации: Сначала сформулировать требования к другим участникам команды — в каком виде и в какие сроки ему должны предоставить исходные данные для формирования комплекта отчетной документации. С учетом качества и количества исходных данных прикинуть свои трудозатраты на формирование отчетной документации. Уложить это все на план-график исполнения контракта, понять, сколько нужно людей, какой трек согласования документации, и как вообще при этом выжить.
То есть это процессное и ресурсное управление, которым он должен владеть. И это схожие процессы с теми, которые есть у руководителя проекта. Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться. Так что хороший техпис может вырасти до РП. Иногда это классическая аналитика при ведении проектов, когда сначала есть общие верхнеуровневые требования, а затем надо проговорить с заказчиком, что сделать — декомпозировать эти требования, провести трассировку, управлять ими. Бывают и неклассические аспекты аналитики. Например, мы берем проект, которым ранее занимался другой подрядчик.
Попросим работодателя открыть отзывы","employerReviews. Возможно, сама компания рассказала о них в вакансии — посмотрите описание. Теперь соискатели видят 1 отзыв. Вы получили статус «Открытый работодатель»","employerReviews. Кандидаты увидят ответы на hh. Воспользуйтесь шаблоном — его можно редактировать.
Иногда, когда просто смотрю в интернете, на похожие натыкаюсь. И даже мне кто-то присылал из коллег — говорят, посмотри. Иногда так бывает, что поставщик — фабрика, на которой производятся наши модели, — перепродает ее кому-то другому тоже из России, и они долго не парятся — просто переправляют модель, и всё. Мне не обидно, авторское право ж не мое. Мне кажется, эта претензия должна быть к фабрике и производителям выставляться. Но чаще всего это не прокатывает, потому что всем пофиг. Особенно китайцам. Трудности перевода Технику, к которой молодой человек пишет инструкции, разрабатывают и выпускают в Китае — как и большинство девайсов сегодня. Изначально он получает информацию на английском, порой переводит с китайского, и затем уже создает руководство, понятное для русскоязычных пользователей. Но бывают и казусы, порой весьма смешные, когда китайская сторона вносит свои исправления. Было такое несколько раз. И за это им прилетало. Например, в схему изменения вносили правки. Еще как-то решили мой русский язык править, мы потом смеялись всем офисом — только китайцам может прийти такое в голову. Приходит нежданчик, сюрприз в коробке, ее открываешь, а там такое, — улыбается технический писатель. Я этого не писал! От китайцев постоянно сюрпризов только жди — приходит всё не так: провода с другими цветами и так далее. И приходится потом переписывать и перепечатывать, а дизайнерам — коробки перерисовывать. Так что за косяки китайцев приходится отвечать не только мне, но и всем остальным. Вот какие ляпы возникают после китайской адаптации техники: 1 из 5 Источник: предоставлено героем публикации Технический писатель говорит, что изначально приходят инструкции на «китайском» английском, но за долгие годы работы он уже научился понимать, о чем идет речь.
: техническим писателем ✒
Специальность технический писатель появилась не так давно, однако уже является востребованной. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. девушка при исполнении, а в свободное время - поэт.