Профессия "Технический писатель", или "Рыцари клавиатуры". Базовые сведения. Приемы работы с текстом и программным обеспечением

В книге подробно рассматриваются все аспекты работы технического писателя — от первых шагов и введения в профессию "Технический писатель" до обзора применяемого программного обеспечения и организационных вопросов трудоустройства. Также обзорно рассматриваются вопросы трудоустройства и работы за рубежом и современные тенденции в профессии. Адресуется всем, кто уже работает "техписом" или еще только собирается овладеть этой специальностью.

Жанры

Рейтинг LiveLib

3,6

7 оценок

5
29%
4
29%
3
29%
2
14%
1
0%

Ваша оценка

Прочитали 10Хотят прочитать 19

Рецензии

Ingris3 февраля 2022 г.
А не хотите ль стать техписом?
Книжечка на полторы сотни страниц полностью соответствует названию - базовые сведения о профессии "технический писатель". Так как данной профессии в перечне тех, каким учат в нашем профобразовании, нет, а вакансии по ней есть, да еще и с зарплатой куда повыше МРОТ, то книга вполне себе актуальна в узких кругах желающих узнать, что требуется от техписа, в чем его работа в общих чертах, что для нее нужно. И внезапно может оказаться, что можно попробовать войти в ай-ти, не будучи программистом, что в багаже гуманитария-гика найдутся вполне себе годные для резюме техписа методички и инструкции пользователя, сочиненные на предыдущих бюджетных работах, или там статьи в бложике либо видеоинструкции, созданные для себя и немногочисленного круга подписчиков...
Одна из специализаций автора - обучение технических писателей (он даже курсы создал), что добавляет сказанному веса; материал хорошо структурирован, мысли сформулированы достаточно четко и просто для понимания неспециалистом. В своей книге Михайлов дает практические советы для начинающих, бегло, но разносторонне описывая рабочие моменты, от особенностей типа занятости до особенностей создания документов для разной целевой аудитории, включая приемы работы и коротенькое описание программ для работы. Для людей, что уже работали во фрилансе или писали техническую документацию по работе в большом объеме (пусть и работая по другой профессии), нового, конечно, не так уж много, все же информация тут базовая.
Отдельно накосячило издательство. И если дату издания "2022 год" на книге, купленной в 2021 году, еще можно как-то понять и простить, то ляпы в наборе текста, словно отсутствовал корректор, смотрятся неприятно - причем в книге, какбэ имеющей своей целевой аудиторией людей с высокой грамотностью. Символично выглядят нелады с грамотностью во фразе "легко найти обычную опечатку, но если у самого не лады с грамотностью, то исправить чужую ошибку будет проблематично, будь она грамматической или пунктуационной" - в издательствах теперь совсем-совсем экономят на проверке рукописей? Что ж, оставшимся без работы редакторам и корректорам эта "инструкция" предлагает выход - "гоу в техписы, я создал!"
Читать далее
5
242
StasiyaPisnova30 июня 2023 г.
Подходит, если нужно пробежаться по верхушкам
Когда я получила эту книгу в свои руки и обнаружила, что пункты содержания на две трети состоят из пунктов курса по переподготовке от ProText, я решила уделить книге время.
И у меня сложилось впечатление, что книга написана довольно поверхностно. Возможно, это объясняется курсом по переподготовке, который стоит гораздо больших денег. Автор не сильно погружается в охватываемые области, даёт общие советы из разряда «всегда читайте договор» и не приводит своих «фишек» или случаев с работы. Для меня это было бы интересно, потому что в работе порой попадаются совсем неординарные задачи, с решением которых не помешал бы чужой опыт.
Как пример: автор лишь в двух словах обмолвился о видеоинструкциях — всё ещё редком звере в работе технического писателя. Как лучше строить показ действий? Стоит ли что-то отдельно выделять? Как можно автоматизировать поддержку таких инструкций? Вместо ответа на такие вопросы автор просто упомянул, что видеоинструкции существуют и что для них есть специализированный софт (который по факту является просто софтом для захвата видео с экрана и базового монтажа).
Или, например, в главе про варианты занятости технического писателя автор пишет про фриланс, но не упоминает варианты юридического оформления такой деятельности и способы расчёта и уплаты налогов. С другой стороны, книга была написана (по данным LiveLib) в 2018 году, когда в России ещё не заработал закон о самозанятых. А значит, тогда и вариантов оформления работы на фрилансе было меньше.
Возможно, у меня сложилось такое мнение, потому что я уже в профессии. Возможно, интересующимся переходом в техписательство книга покажется более полезной. У меня же ощущения двоякие: это нельзя назвать бесполезной тратой времени, но чего-то принципиально нового я не узнала.
Читать далее
2
181

Все рецензии

Цитаты

Ingris28 января 2022 г.
Оглавление — это основа и структура, на которой будет базироваться дальнейшее описание. Разумеется, в каждом конкретном документе оно будет чуть различаться, но в общем стандартном случае его можно представить так:
Введение. Необязательный элемент, который может быть заменён аннотацией. Содержит краткую информацию о назначении программы, о содержании самого документа и указание его целевой аудитории. Занимает не более страницы. Для ПО и оборудования раздел выглядит одинаково.
Общая информация. Это один или несколько разделов (глав, параграфов и т.д.), содержащих сведения о системных и аппаратных требованиях программы, её ключевые характеристики, расширенную информацию о её назначении, данные об авторских правах. Зачастую сюда же выносятся сведения, связанные с её лицензионным использованием. Для оборудования отличий здесь также нет, кроме возможных требований к условиям эксплуатации (температурный режим, например).
Используемые обозначения и сокращения. Раздел, где вы перечисляете и расшифровываете все используемые в тексте сокращения (кроме общепринятых, вроде «и т.д.»), аббревиатуры и значки (например, восклицательный знак «Внимание!». Иногда его может не быть, вместо этого все сокращения расшифровываются при первом упоминании в тексте.
Установка. Алгоритм действий по установке ПО на компьютер или установке в помещение и подключению к сети электронного оборудования.
Настройка. Описывается комплекс подготовительных мер, предназначенных для ввода в эксплуатацию программы или устройства. Для многих бытовых изделий и приложений для домашних ПК этот пункт может отсутствовать, поскольку нет обязательных к изменению настроек.
Использование в работе. Часть, непосредственно посвящённая описанию приложения или устройства и работе с ним пользователя. Основной и самый крупный раздел документа.
Удаление. Для ПО в этом разделе описывается стандартная процедура удаления, для оборудования — демонтаж и условия утилизации, если они отличаются от типовых (вынести на помойку).
Возможные проблемы и частые вопросы. Это не обязательный, но очень желательный в любой инструкции раздел. Особенно он требуется различным новинкам, которые представлены на рынке первыми версиями и за которыми пока нет многих человеколет отладки и устранения ошибок в различных нештатных ситуациях. В разделе перечисляются наиболее часто встречающиеся ошибки и неполадки с указанием, как поступать пользователю при их возникновении.
Читать далее
1
122
Ingris28 января 2022 г.
Стоит отметить, что браться за написание руководства к программе можно лишь тогда, когда вы уже изучили её вдоль и поперёк. При попытке описать продукт параллельно с его изучением (по принципу: «что вижу — то пою»), вы с очень высокой (примерно 146%) вероятностью сядете в лужу или, в лучшем случае, сделаете всю работу два раза подряд, поскольку вам придется постоянно возвращаться по тексту назад, чтобы исправить всплывшие в ходе дальнейшего изучения программы нюансы или неточности.
1
84