Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. Самые свежие новости России и мира, новости политики, шоу-бизнеса.
Наука и техника
Перед началом описания необходимо изучить функционал. То, как вы поймете его изначально, повлияет на качество текста в целом. Чтобы посмотреть, как работает программа, запрашиваю ее в отделе разработки. Для начала в документе создаем примерную структуру — в какой книге будет располагаться новый текст, какие разделы появятся, что они будут в себя включать.
Книги обычно подразделяются на руководства для пользователя, администратора и разработчика. В зависимости от этого, описание выполняется на языке, понятном представителю одной из ролей. Например, для пользователя нужно писать «простым» языком, давать подробный порядок действий, для разработчика, напротив, нужны четкие формулировки с терминами, описание рабочих примеров кода.
Вам сложно понять, что нужно писать, с чего начинать, как писать? Не переживайте. Для каждого типа описываемого объекта, например, справочник, сценарий или установка, имеется отдельный формат описания.
Формат задает структуру описаний, предоставляет готовые типовые фразы, правила оформления текста. Проще говоря, формат — это шаблон для новых текстов. Мы пишем не поэмы, не повести, требующие творческой окраски, мы пишем техническую документацию, которая должна быть простой, структурированной и понятной любому.
Запускаю программу и поочередно описываю каждую ее вкладку: «Основное окно», «Настройки». Обязательно добавляю назначение программы и общие разделы, например, «Способы запуска». Структуру текста я как раз беру из готового формата описания.
Если возникают вопросы, ответы на которые не удалось найти ни в технических проектах, ни в интернете, можно напрямую обратиться с вопросами к разработчику.
Над отдельным проектом обычно работает не один человек, а несколько. Поэтому нужно, чтобы каждый был в курсе дел и смог вовремя получить необходимую информацию. После летучки возвращаюсь на рабочее место. Сегодня мне нужно описать работу новой программы. Список отбираемых работ берется не наобум.
Ежедневно никто не станет напоминать, что тебе нужно описать. Процессом планирования занимается сам технический писатель: пересматривает документы отделов разработки что сделали, как это работает , открывает тестовые разработанные программы смотрит и вручную проверяет их работу. И из всей полученной информации выбирает только то, что влияет на документацию. Теперь я создаю документ, в котором буду разрабатывать описание программы. Перед началом описания необходимо изучить функционал. То, как вы поймете его изначально, повлияет на качество текста в целом.
Чтобы посмотреть, как работает программа, запрашиваю ее в отделе разработки. Для начала в документе создаем примерную структуру — в какой книге будет располагаться новый текст, какие разделы появятся, что они будут в себя включать. Книги обычно подразделяются на руководства для пользователя, администратора и разработчика. В зависимости от этого, описание выполняется на языке, понятном представителю одной из ролей. Например, для пользователя нужно писать «простым» языком, давать подробный порядок действий, для разработчика, напротив, нужны четкие формулировки с терминами, описание рабочих примеров кода. Вам сложно понять, что нужно писать, с чего начинать, как писать?
Мы обсудим вопросы: Какие новые термины из области мобильной разработки должен знать техрайтер? Необходимо ли техническое задание на мобильное приложение? Каким может быть туториал в мобильном приложении? Что писать в справке к приложению? Будут ли пользователи читать сопроводительную документацию на сайте?
Так было всегда и так будет до скончания века». На страницах этой книги вы познакомитесь со всеми жителями небольшой деревеньки, в которой провел свое детство будущий писатель. В 2002 году выходит в свет сборник рассказов «Полынья». Истории, рассказанные писателем просты. Но в каждой истории главный герой через жизненные испытания, муки совести обретает духовную свободу. За эту книгу Владимир Николаевич становится лауреатом литературной премии Нижний Новгород. Известный нижегородский писатель Валерий Шамшурин так сказал о нем: «Если вы спросите меня - какую книгу читать всей семьей? Я отвечу - откройте книгу "След облака". Перед вами предстанет мир бесконечно узнаваемый, но исполненный величия и значения. Вашими собеседниками станут простые русские люди с непростым духовным миром, с умением жить несмотря ни на что и видеть красоту мира. Это очень русская книга». В 2006 году вышла еще одна книга В.
Зачем нужны технические писатели
США после подписания законопроекта о военной помощи смогут начать снабжение украинской армии боеприпасами и вооружением с американских складов в Германии всего за несколько дней. Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий. Я технический писатель, хотя в последнее время скорее knowledge manager. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям.
Кто такие технические писатели и зачем они нужны в команде
Мы в соцсетях Контактные данные для Роскомнадзора и государственных органов «Фонтанка» — петербургское сетевое издание, где можно найти не только новости Петербурга, но и последние новости дня, и все важное и интересное, что происходит в России и в мире. Здесь вы отыщете наиболее значимые происшествия, новости Санкт-Петербурга, последние новости бизнеса, а также события в обществе, культуре, искусстве.
Технический писатель — специалист, находящийся на стыке двух областей: он должен хорошо знать язык, на котором пишет, и разбираться в технологиях, о которых пишет. Мы живем в век высоких технологий, поэтому сфера IT — одна из наиболее развивающихся в современном мире. Впервые сталкиваясь с каким-нибудь новым устройством и открывая инструкцию по пользованию, вот здесь мы и видим работу технического писателя technical writer , задача которого — донести до простого пользователя сложную техническую информацию понятным, «человеческим» языком. И то, будет ли информация из справки нам полезна, а в конечном итоге — каково будет наше впечатление о новом продукте, во многом зависит от квалификации технического писателя. Некоторые скажут, что они, дескать, и не писатели вовсе, так — просто инструкции составляют.
Экзамус Экзамус разработал технологию, которая анализирует поведение пользователей любых онлайн-сервисов с помощью распознавания лиц и обнаружения эмоций. Для работы с продуктом достаточно наличия у пользователя мобильного устройства или компьютера с веб-камерой. Инструмент, который помогает контролировать соблюдение правил в рамках онлайн-тестирований и бороться с академической недобросовестностью. Подробнее Функции прокторинга подключаются к платформам тестирования, что позволяет проводить контролируемые дистанционные экзамены как в ручном, с участием прокторов, так и в автоматическом режиме.
Контактные телефоны:.
Военная операция на Украине
«Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. Опыт работы в аналогичной должности (или инженером – электроником) от одного года. Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия
День технического перевода
В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы. Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса.
Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным.
Клиент всегда прав — отгрузка до 23. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу. Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены.
Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы. Большие надежды — портал bercut. К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла. Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками.
Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу. Сейчас мы работаем над созданием портала, на который сможем выгрузить документацию в формате HTML. Там будет предусмотрен удобный полнотекстовой поиск по всем страницам или по части документации, например, по страницам на определенную версию определенной системы. Да здравствует Команда! Также по пятницам у нас обычно проходит еженедельное совещание нашей команды в Skype.
Эта традиция появилась у нас с переходом на удалённый режим работы. На совещании наш Team Lead делится с нами свежими новостями компании Bercut, рассказывает о новых краткосрочных и долгосрочных задачах и планах. Писатели по очереди рассказывают о своих задачах и рабочих проблемах — что сделано за прошедшую неделю, что планируется сделать на следующей. Такое обсуждение помогает нам скоординировать свои действия, ведь часто над пакетом документов к очередной версии системы работает сразу несколько писателей. Последний штрих Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN.
Конечно, мы часто выполняем промежуточные синхронизации и в середине дня, но вечером обязательно проверяем, все ли изменения выгружены на сервер.
Наша аудитория — лидеры бизнеса и политики, чиновники, десятки тысяч горожан.
Вот чем будет полезно техническое образование: — технический склад ума и системное мышление — отличные спутники в IT-сфере; — навыки программирования помогут понимать разработчиков; — опыт написания материалов технической направленности пригодится, чтобы формулировать сложные вещи простыми словами. Образование лингвиста и знание фундаментальных основ языка помогут сделать тексты логичными и понятными для пользователя. И любое высшее образование научит добывать, отбирать и структурировать информацию, критически мыслить и быстро ориентироваться.
Есть и базовый набор умений, которые не зависят от образования, но сильно упростят техпису жизнь: Грамотность. Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения.
Техпис постоянно общается с разными людьми. С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать.
Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса. Выглядит так, будто для полноценной документации этого недостаточно.
Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно.
Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру.
Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются.
Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель.
У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной.
И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай».
Я подумала, что это хороший знак и меня ждет отличный день 19. Покупаю билет на электричку: 20. Смотрю расписание, а сзади меня уже крадется поезд: 21. Из окна можно лицезреть разные виды граффити - пошлые и не очень, красивые и страшные, милые и жуткие и много других. Однажды появился новый рисунок, я ехала грустная и злая, но увидела его и сразу разулыбалась. Интересных граффити больше нет, можно почитать. Некоторое время назад решила перечитать всего Достоевского, очень развивает Жаль, что заграницей этого писателя любят намного больше, чем у нас в России. Я не буду показывать и описывать свой день в офисе, он не отличается чем-то интересным.
Я сижу весь день уткнувшись в PHP-код, часто с угрюмым лицом, иногда среди тишины раздаются мои возгласы или возгласы программиста. Изредка смех технической поддержки и ооооооочень редко ворчание начальника. Конец рабочего дня официально в 7 вечера, но голова пухнет от компьютера и программного кода, меня ждет друг и я сбегаю из офиса. Время: 25. Мы встретились и решили пойти в Парк Горького, я давно не была и мне все рассказывали, как здорово там сейчас сделали. А еще я сначала совсем забыла, что нужно фотографировать всё вокруг и вспомнила только на милых уточках: 26. Этой мой друг. Друга зовут Максим. Мы хотели покататься на лодках, но там была огромная очередь!
История профессии технического писателя
Andrei Serikov in Технические писатели. З марта отмечается Всемирный день писателя03.03.2022 18:33 — ННТВ (видео). Поэтому какое-то время мечтала стать писателем. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости. Историю празднования Дня писателя узнают те, кто придет в библиотеку №107 (Перовское шоссе, д. 16/2).
(Удаленка) Требуется технический писатель.
Еще во времена студенчества Сутеев стал членом экспериментальной группы мультипликаторов. Мультипликационный дебют мужчины состоялся во время его работы над картиной «Китай в огне». В данной картине впервые был использован альбомный метод мультипликации. В 1924-1925 годах художник занимался рисованием рекламных киноплакатов для таких фильмов, как «Девушка в маске», «Куртизанка», «Жена фараона» и многие другие.
И этот сотрудник обладает способностью быстро вычитывать договоры, сразу подмечая места в документе, где могут возникнуть проблемы. Это полезно, так как РП тяжело погружаться в эти юридические тонкости. И здесь задача технического писателя — прикрывать РП по формальной части. Вертикальный рост технического писателя Вертикальный рост технического писателя прост и понятен.
В подразделении Nota. Docs четко выстроена градация между специалистами уровня Junior, Middle и Senior: Junior — новичок, обладающий базовыми компетенциями: грамотность, владение MS Office, системность и структурированность мышления, внимательность к деталям. Но ему нужна помощь от более опытных коллег по ряду вопросов. Middle — это человек с опытом, который работает самостоятельно. Если ему поставили задачу, он не прибегает к помощи других коллег-техписов. Это не означает, что он не имеет права задавать вопросы другим участникам проектной команды. Но значит то, что за ним не надо проверять.
Он знает, как добыть информацию, к кому пойти по тому или иному вопросу и знает срок, к которому все должно быть сделано, а также в каком объеме и качестве. Senior — это уже расширенные компетенции и нечто большее, чем все функциональные обязанности специалиста Middle. Это «большее» может быть с точки зрения, например, управленца — то есть человек, который ставит задачи нескольким мидлам. Или человек, который глубоко знает определенную предметную область или систему. Поэтому специалист может вырасти до ведущего технического писателя, в подчинении которого находится несколько специалистов, затем — в руководителя подразделения технической документации. Кому подходит карьера технического писателя Главное качество, которое отличает технического писателя — это ответственность. Потому что мы работаем с формальным треком, который с крупным заказчиком проходит через его внутренний электронный документооборот, сопроводительные бумаги и письма.
Поэтому невозможно физически договориться о том, что мы сегодня не успели и сделаем завтра. Если срок сдачи документа — 30 сентября, то не позднее этого дня он должен быть любой ценой. Но при этом вариативность типа личности, которому подходит карьера технического писателя, велика. Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики. Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит. Предположим, в компании открыто несколько вакансий технических писателей на разные проекты.
Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов. Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы. Например, пояснительную записку на 1000 страниц с техническими подробностями. Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст. Типаж 2 — «решала» Проект Б. На проекте много согласующих, но несложная документация. Не требуется глубоко лезть в технические вещи.
Как говорила матерь всех переводчиков Нора Галь, «переводить надо не слово, не букву, а дух и смысл». И я верю в то, что этот принцип должен лежать в основе любой работы с текстом, особенно в работе технического писателя. С чем бы вы ни работали, думать о смысле — лучшее, что вы можете сделать для себя, для читателя и для заказчика. Это избавит вас от многих проблем и поможет решить большинство возникающих в работе вопросов.
И, конечно же, не только сделает ваш «перевод на пользовательский» полезным, но и заставит его звучать нативно. Хорошее владение IT-терминологией, погружение в IT-тематику. Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования.
Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис.
Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач. Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов.
Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают.
Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение.
Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу.
Она вручается ежегодно с 1996 года за лучшее прозаическое произведение на английском языке. Наиболее экранизируемым писателям является Эдгар По.
Сюжеты произведений этого американского писателя вошли в 114 кинофильмов. В Великобритании писательница Агата Кристи считается одним из символов страны и почитается наравне с королевой. Тираж ее произведений уступает только Шекспиру и Библии. О профессии писателя Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными.
Писатели должны хорошо владеть языком и обладать индивидуальным стилем. Люди, которые хотят посвятить себя писательству, учатся в ВУЗах на филологических и гуманитарных факультетах.
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
Новости дня читайте на Взгляде. Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. Опыт работы в должности бизнес-аналитика или технического писателя от 1 года. Иркутского Государственного Технического Университета ISSN.
Технический писатель
Новости дня читайте на Взгляде. З марта отмечается Всемирный день писателя03.03.2022 18:33 — ННТВ (видео). Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования.