Профессия "Технический писатель", или "Рыцари клавиатуры" - [28]
Специалисты по эксплуатации техники — обладают тем же уровнем знаний относительно используемого оборудования, что и системные администраторы в вычислительных сетях, но, как уже понятно, работают с оборудованием, а не с ПО, и имеют, как правило, узкую специализацию.
В основном сюда относятся операторы различных промышленных установок, будь то станки с ЧПУ, врачи-диагносты, или операторы любых других сложных механизмов. При высокой квалификации подобных работников, у большинства из них есть «профессиональная привычка» к оборудованию, на котором они работали ранее (возможно, многие годы). Поэтому они, зачастую, с недоверием относятся к новой технике, хотя и приветствуют её обновление.
Основная сложность в написании документации для них (по сути это инструкция пользователя, но из-за сложностей выполняемых задач её трудно отличить по уровню от администраторской) — изложить материал с учётом специфики их работы. Оптимальной для них является документация, где кроме руководства и описания самого оборудования приложены готовые кейсы по конкретным задачам, но для создания этих кейсов автору текста нужно глубоко вникать в тему, возможно, придётся консультироваться с соответствующими специалистами, для которых и делается разработка. Если такая возможность есть — вы сможете написать отличный документ, который на время освоения станет настольной книгой оператора вашего оборудования. Если же нет — то лучше выбрать наиболее понятный язык изложения, не пренебрегая фотографиями важных узлов и пультов управления оборудованием.
Чаще всего эта документация поставляется в печатном виде, что нужно учитывать при оформлении текста.
Разработчики — те, кто создал приложение, описанием которого вы в данный момент и занимаетесь. Разумеется, непосредственным авторам программного кода никакие комментарии и пояснения к нему не требуются. Зато эти знания будут очень полезны новичкам, только приходящим в команду разработки. Какими бы крутыми специалистами они ни были, им потребуется время, чтобы вникнуть в принцип работы этой конкретной программы, и наличие документа, полностью описывающего её «внутренности» будет им очень кстати.
Для этой целевой аудитории не нужно писать каких-либо длинных текстов с большим количеством описаний «от себя», основная информация добавляется в виде комментариев напрямую в файлы программы.
В документации для этой ЦА требуется описать код программы в виде алгоритмов и блок-схем, все имеющиеся функции (какие значения принимает, что с ними делает, данные каких типов возвращает и т.д.). Желательно сделать глоссарий глобальных переменных. Обычно комментарии добавляются напрямую в код программы, а описание и все графические элементы выносятся в отдельный файл. В дальнейшем любой программист, если ему «не влом» или рядом стоит его начальник с ломом, может, внося изменения в соответствующий модуль программы, поправить и текст комментария.
Если речь об описании баз данных (далее: БД), то описываются все таблицы БД, их поля, строится карта взаимодействия (графическая схема БД). Другие данные для описания таблицы не требуются — специалисту по работе с ней упомянутых сведений будет более чем достаточно.
На самом деле, этот тип документации нужно писать самим программистам, но, как показывает практика, в 99% случаев их абсолютно невозможно заставить делать это, поэтому приходится подключаться техническим писателям.
Экономисты и менеджеры — они не читают инструкций. Они не пользуются вашим ПО. Им не важно, как оно работает и сколько классных и уникальных функций имеет. Им нужен материал, который поможет принять решение: купят они ваш продукт или какой-то другой. Соответственно, писать для них нужно не руководство, а аналитический или обзорный материал, который попадёт к ним от менеджеров вашей компании, а то и вовсе через прессу.
Работая над текстом для этой категории читателей, вы должны понимать, что ваша задача подать материал так, чтобы экономист, принимающий решение о приобретении, однозначно понял, что ваш продукт может решить все стоящие перед его сотрудниками задачи, и при этом стоит не слишком дорого.
В то же время важно понимать, что во многих компаниях, особенно ориентированных на IT, решения о покупке ПО и оборудования принимаются техническими специалистами в обход экономистов — технари сами решают, какой продукт им нужен, не глядя на его цену.
В такой ситуации, разрабатывая материал, вы должны ориентироваться на представителей обоих этих направлений, так как они выступают в одной роли — лиц, принимающих решение о приобретении вашего продукта (технари потом инструкцию почитают, если купят, на предварительном этапе им важен функционал и удобство, а не порядок нажатия клавиш).
Следовательно, ваш текст должен быть и техническим (рассказать технарям, сколь безмерно крута ваша разработка и как лихо она решит все их проблемы и задачи), и продающим (показать экономистам все финансовые преимущества использования вашего продукта).
Почти вся существующая серьёзная аналитика, которая пишется по заказу компаний, создаётся специально для этой категории пользователей.
Книга состоит из коротких рассказов о кораблях, имена которых вошли в историю революционной борьбы нашего народа и в историю Великой Отечественной войны, о кораблях-памятниках. Оживают наиболее яркие страницы истории отечественного флота и истории флота других морских стран. Рассказы посвящены также отважным мореплавателям, совершившим Великие географические открытия, истории создания знаменитых кораблей, проекты которых представляют интерес и для судостроителей наших дней. Книга предназначена для всех тех, кого интересует история судостроения и история мореплавания.
Мы, по существу, еще мало знаем, как человеческий мозг творит новое — скажем, новую песню, оригинальное произведение, необычную машину и т. д. Нам известно число клеток мозга (их 14–17 миллиардов), известно, какая его область какой функцией организма управляет, но мы не в состоянии отличить мозг гениального человека от мозга рядового жителя планеты. Природа любого дарования, таким образом, загадочна. Однако как происходит процесс открытия, процесс изобретения, описать можно. Б. Блинов, инженер-изобретатель, и делает это в своей книге.
Каждый человек должен знать, как работает его тело и особенно желудочно-кишечный тракт. Ведь 99% болезней человека от неправильного питания. Это вторая книга Горацио Флетчера о питании человека. В первой части мы писали о пищеварении в ротовой полости. В этой книге мы поговорим о роли желудка и кишечника. Мы слишком много едим? Можем ли мы научиться правильно питаться? Без потери удовольствия? Не беспокоясь о неприятностях? Без вмешательства общества? С уверенностью в здоровье? С увеличением энергии? С повышением выносливости? На все эти жизненно важные вопросы эта книга отвечает только ДА.
В 2020 году атомной промышленности России исполнилось 75 лет. Энергия атома удивительна и универсальна – это основная и неисчерпаемая энергия Вселенной. Она применяется во многих сферах жизни, самое главное – использовать ее мирно и разумно, ведь, как говорил основатель атомной промышленности Игорь Курчатов, атомную энергию можно превратить «в мощный источник энергии, несущий благосостояние и радость всем людям на Земле». Автор книги – профессор кафедры теоретической физики им. Э. В. Шпольского и научный руководитель УНЦ функциональных и наноматериалов Московского педагогического государственного университета Ирина Разумовская. Издание с дополненной реальностью. В формате PDF A4 сохранен издательский макет книги.
Исторические, или историко-ориентированные, информационные системы – значимый элемент информационной среды гуманитарных наук. Его выделение связано с развитием исторической информатики и историко-ориентированного подхода, формированием информационной среды, практикой создания исторических ресурсов. Книга содержит результаты исследования теоретических и прикладных проблем создания и внедрения историко-ориентированных информационных систем. Это первое комплексное исследование по данной тематике. Одни проблемы в книге рассматриваются впервые, другие – хотя и находили ранее отражение в литературе, но не изучались специально. Издание адресовано историкам, специалистам в области цифровой истории и цифровых гуманитарных наук, а также разработчикам цифровых ресурсов, содержащих исторический контент или ориентированных на использование в исторических исследованиях и образовании. В формате PDF A4 сохранен издательский макет.
