Мы ищем технического писателя в команду Indeed Access Manager. Свежие новости Москвы на сегодня и завтра. Какое метро откроют, какими будут «Лужники». Последние новости на официальном сайте Мэра Москвы.
НОВОСТИ ДНЯ
Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя. Киножурнал "Новости дня" выходил с 1944 по 1983 годы. В этот четверг (25.11) в 18-00 пройдет презентация профессии технический писатель и команды технических писателей Orion Innovation. Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. Известный нижегородский писатель Валерий Шамшурин так сказал о нем.
366. День технической книги
Дневник писателя Ф. М. Достоевского. Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям. Свежие новости Москвы на сегодня и завтра. Какое метро откроют, какими будут «Лужники». Последние новости на официальном сайте Мэра Москвы. В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября. Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области.
Вход в систему
- Кто такой технический писатель и чем он занимается
- Новости по теме
- День технического писателя
- Яндекс Образование
- Про плагиат
- День рождения инженера и писателя-фантаста
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя.
НОВОСТИ ДНЯ
Кроме того, Документерра является серебряным партнером конференции и выступит с докладом о мировых тенденциях в области документации. Приглашаем вас присоединиться к нам, чтобы послушать выступление нашего технического директора и принять участие в обсуждении. Будем рады видеть вас на мероприятии! Когда и где: 5 — 6 апреля, Москва, РФ.
Write the Docs 12-я ежегодная конференция Write the Docs в Портленде приглашает участников технического сообщества поделиться своими идеями и знаниями. Изначально мероприятие проводилось для разработчиков, но теперь оно включает всех, кто проявляет интерес к документации. Конференция нацелена на объединение специалистов по документации для обмена опытом, укрепления профессиональных связей, приобретения новых навыков, вдохновения и приятного времяпрепровождения.
Дополнительную информацию можно получить на сайте конференции. Когда и где: 14 — 16 апреля, Портленд, США. Это событие соберет вместе профессионалов различных направлений в индустрии разработки: backend, frontend и fullstack-разработчиков, тестировщиков и QA-специалистов, web-дизайнеров и проектировщиков интерфейсов, системных аналитиков, тимлидов, техлидов и менеджеров разработки.
Участникам будет предоставлена возможность рассказать о своей компании, продуктах и новых проектах. Техническим писателям также будет интересно присоединиться! Когда и где: 26 апреля, Екатеринбург, РФ.
Будучи самой старой организацией в данной области, STC предоставляет широкие возможности для общения и обучения у коллег, интенсивные сессии по ключевым темам и обновлениям в отрасли. Это мероприятие способствует постоянному развитию знаний, навыков и общения для профессионалов в области технической коммуникации.
В Великобритании писательница Агата Кристи считается одним из символов страны и почитается наравне с королевой. Тираж ее произведений уступает только Шекспиру и Библии. О профессии писателя Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными. Писатели должны хорошо владеть языком и обладать индивидуальным стилем. Люди, которые хотят посвятить себя писательству, учатся в ВУЗах на филологических и гуманитарных факультетах. Однако большинство писателей не имеют специального образования, а их профессии далеки от литературы.
Этот род деятельности подходит людям, наделенным литературным талантом и развитой фантазией.
Если возникают вопросы, ответы на которые не удалось найти ни в технических проектах, ни в интернете, можно напрямую обратиться с вопросами к разработчику. Бояться тут нечего. Каждый сотрудник компании дружелюбно ответит вам либо перенаправит к человеку, который более компетентен в поставленном вопросе. Не забывайте, мы же одна команда!
В перерывах между описаниями наступает обед. Время на работе течет в быстром темпе, не успеешь и заметить, как утро кончится. Насытившись и отдохнув, с полными силами возвращаемся и погружаемся в поток рабочего процесса. После обеда мне осталось дописать ещё несколько страниц. Перечитываю написанное и отправляю текст на согласование рецензентам. На этом этапе другие сотрудники рецензенты проверяют текст на понятность и верность изложения, а также при необходимости проверяют пунктуацию, синтаксис и структуру текста.
Кроме описаний технический писатель также выполняет технологические задачи. Для этого необходимо хорошо знать инструменты для разработки и оформления документации. Если вы с ними ранее не встречались, то на рабочем месте вы с легкостью их освоите. Во второй половине дня мне пришла задачка по сборке руководства пользователя в формат PDF. Совсем нет. Все элементарно и просто.
Доработали оформление, а там уже и вечер подступил.
Требования: - Опыт подготовки технической документации ГОСТ 19, ГОСТ 34 ; - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию; - Уверенное владение пакетом офисных приложений Word, Excel ; - Базовое понимание процессов разработки программного обеспечения. Контактные телефоны:.
НОВОСТИ ДНЯ
Некоторые работодатели требуют, чтобы образование у технического писателя было техническим. Другим нужно просто высшее образование. Еще одно требование — знание иностранного языка, потому лингвисты, филологи, переводчики тоже востребованы. Хорошо пишут тексты и коммуникабельны, как правило, выпускники гуманитарных направлений: литераторы, журналисты. Если человеку с таким образованием понравится разбираться в новой для себя области, то, скорее всего, ему подойдет эта профессия. Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации.
Кому нужен технический писатель. Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель. Технические писатели четким языком излагаю информацию. Большинство технических специалистов являются экспертами в своей области, они формируют описание продукта для равной себе аудитории. Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики — именно такой формат позволяет создать инструкцию, понятную всем участникам проекта. Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации.
Документация хорошего качества положительно влияет на продукт. Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию. Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования. Устранив эти проблемы до релиза продукта, можно быть уверенным, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта. Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами — это то, что большинство разработчиков никогда формально не изучали.
Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода. Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя — писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно — он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты. Даже если «этот снаружи» сидит в соседней команде. Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя. Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен.
Мы в соцсетях Контактные данные для Роскомнадзора и государственных органов «Фонтанка» — петербургское сетевое издание, где можно найти не только новости Петербурга, но и последние новости дня, и все важное и интересное, что происходит в России и в мире. Здесь вы отыщете наиболее значимые происшествия, новости Санкт-Петербурга, последние новости бизнеса, а также события в обществе, культуре, искусстве.
Об этом нужно рассказать подробнее. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге.
По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться.
Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira.
У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана.
В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП.
Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно. Может быть, после некоторого размышления, он догадается, что все эти названия описывают одно и то же. Но мы же любим наших пользователей, зачем постоянно заставлять их решать подобные головоломки? Есть ещё одна важная особенность технических текстов: кроме правильного употребления общих терминов важны также фигуры описания. Так называются повторяющиеся фрагменты небольшого размера — словосочетания или короткие простые предложения. Например: «Функция … доступна в следующих режимах …» «Чтобы …, выполните в приложении … следующие действия: …» «Задайте системный параметр …» Для фигур описания иногда составляют отдельные словари или справочники. Казалось бы, мелочь. Но пользователь привыкает к определённым конструкциям и фразам. Если в одном месте документа написано «Выберите режим», а в другом «Перейдите в режим», у пользователя может возникнуть сомнения: здесь описано одно и то же действие или разные? Задача технического писателя — унифицировать весь тот зоопарк формулировок и терминов, которые употребляют в своих документах аналитики, разработчики и другие участники процесса разработки ПО. У технических писателей обычно есть свои словари терминов и фигур описания. Опытный писатель разбирается в системе и понимает, что именно означает тот или иной жаргонный термин во внутреннем документе. Вратарь разработки Технический писатель — лучший гуманитарий среди технарей и лучший технарь среди гуманитариев. Михаил Острогорский Выходит, что технические писатели в пользовательской документации исправляют все недостатки, ошибки и неточности, допущенные во внутренней документации и метаданных в процессе проектирования и разработки системы.
: техническим писателем ✒
Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля. 3 марта отмечается Всемирный день писателя. Этот праздник был учрежден в 1986 году по решению конгресса Международного ПЕН-клуба, который был основан в Лондоне в 1921 году. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. SQA ANALYST TECHWRITER DAYSСмотреть онлайн - Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей.