Прекрасные дамы и неподражаемые господа, здравствуйте.
Меня зовут Федор, я технический писатель компании «Цифровая индустриальная платформа». Это совместное предприятие ГК «Цифра» и ПАО «Газпром нефть».
В компании я занимаюсь написанием руководств пользователя и администратора для нашего продукта — Платформы/ZIIoT.
Продукт этот «монументален» и имеет сложную микросервисную архитектуру. В связи с этим — пишу как небольшие руководства по самим микросервисам, так и масштабные, если микросервисы сформированы в «группу» (модуль/бизнес-функция). Когда удаётся выкроить время — веду наш Wiki-Confluence, формирую отдельные/частные руководства.
Скажу вам по секрету – сразу хотел вам показать в тик-токовском стиле «10 крутых лайфхаков как писать текст», устроив из этого целый цикл статей/рубрику.
Однако, меня скорректировали. Сказали, чтобы я начал с самых азов и представил свою профессию, прежде чем учить местных айтишников-учёных. Что же, без занудства и скукоты попытаюсь это сделать. Ближе к концу разберу недавний нашумевший случай и на его примере напишу пару лайфхаков, которые помогут вам выглядеть всегда солидно.
В общем, как говорил один из древнейших составителей цитат волка — «Как бы ты высоко не летал, не забывай, с кем ты ползал» (с) О. Хайям. Так что начнём постепенно.
У меня это первый раз, честно (написание статьи на Хабр)
С порога дам самому себе два правила, которых постараюсь избежать. После прочтения поделитесь, пожалуйста, в комментариях, удалось ли мне:
Я не хотел бы скатываться в пафос о том, как бороздить просторы космоса/построить систему написания документов в условиях *вставить обстоятельства*. Статья без помпы и фанфар, тема приземленная.
Повелительный тон многих представителей моей профессии. Попытаюсь его избежать. «Так надо писать» со скрипучим тоном бесящего одноклассника с первой парты. Могу понять ваш скрежет в зубах по отношению к «нам». Но мы не все такие. Честно.
Смысл данной статьи – познакомить вас с нами и дать любому представителю IT-сферы немного рекомендаций (от джунов до ген. директоров), как иметь солидный имидж, просто избегая определенных ловушек в переписке (на недавно нашумевшем конкретном примере).
Вскользь упомяну, что может насторожить желающего погрузиться в профессию и чуть-чуть поругаю компании за неверный подход к делу.
Роль и важность
Технический писатель в современных компаниях и его роль? Вопрос комплексный.
Разные компании до сих пор не очень осознают, что это вообще за человек. Многие даже по-разному называют: копирайтер, автор статей, специалист по документообороту.
Технический писатель – самый общий термин из всех.
По функциональности – можно ответить вопросом:
Для IT-компаний: нужны ли вам инструкции?
Для авторов: нравится ли проходить обучалки в тяжелых играх? Вот этим, в основном, и предстоит заниматься. Только со стороны обучающего.
К инструкциям постепенно идут дополнения – деление на администратора/пользователя, локальные описания в необычных и нестандартных формах и форматах. Но почти все они должны сводиться к вопросу «Как?».
К сожалению, важность технического писателя осознается только когда компания набила кучу шишек, давая писать документацию аналитикам или разработчикам, менеджерам/рп, административному отделу. В итоге клиент скажет, что ничего не понимает и перейдёт к вашему конкуренту.
Если вам важно видеть именно руководства к вашему объекту – да, нужны мы.
Особенности и перспективы развития
Перспективы развития в этой профессии, в основном, находятся в горизонтальной плоскости. Можно, конечно, дорасти и до директорских должностей, если есть предрасположенность и желание.
Однако, тут нужно любить «тренировать 10 тысяч раз один удар, а не 10 тысяч различных ударов», как говорил Брюс Ли. Полировать, оттачивать себя. Тогда придёт профессиональный успех.
Ну, это не секрет для любой профессии – нужно любить свое занятие, тогда работа будет восприниматься совсем по-другому.
Лично на мой взгляд, предел мечтаний любого человека, кто любит эту профессию – руководство группой тех. писателей.
Кто может стать техническим писателем?
Грамотный и любящий четко доносить свою позицию специалист. По образованию критериев нет: такой специалист может быть как гуманитарного, так и технического склада ума.
Если вам нравится какое-либо из перечисленных ниже занятий, тогда вы можете стать «частью корабля, частью команды»:
Иногда вставить «необычный речевой оборот» в сообщение лишний раз.
Видеть необычные фразеологизмы в книге, которую читаете. Нравится наслаждаться выражением мыслей в виде текста также, как картиной или музыкой.
Собирать паззлы и решать головоломки.
Исправлять себя и самосовершенствоваться. Не только в тексте.
Быть на месте детектива — собирать по частям осколки информации в единое целое.
Если вам это подходит, то вы можете подумать о профессии тех. писателя.
Основная боль
У нас, как у прожженных любителей посещать закрытые собрания определенной тематики, есть два вида боли:
От «неосознания» компаниями того, кто им нужен, на собеседованиях или в первые дни работы.
Уже после найма, при работе в компании.
Ниже опишу типичные ошибки IT-компаний, которые номинально берут себе тех. писателя. Если вы видите, что вам это предлагают на собеседовании – отвергайте это. Вам предлагают очень узкую профессию, не связанную с техническим писательством:
«Нам нужен комментатор кода, чтобы он ещё и сам язык знал».
Это не тех. писатель. Это кто угодно, кроме него. Наймите просто очень грамотного разработчика.«У нас бухгалтер приболел, напиши-ка бух. отчёт».
Сразу нет. Инструкции, руководства, описания объектов, свод правил, что угодно – да. Юридические документы тех. писатель знать не должен.Инструкции идут «в ящик».
Как правило, если такое происходит – это сигнал к тому, что скоро будет буря и придётся попрощаться с компанией. Инструкции должны быть читаемы, обсуждаемы и важны. Если чувствуете себя ненужным – лучше сами сделайте первый шаг.
Итак, если все круги оформления и найма в компанию были пройдены, компания действительно понимает, кто ей нужен, то могут возникнуть проблемы уже на стадии работы, которые нужно пробовать всеми силами решать:
«Невключение» в разработку, отдача материала в конце разработки-спринта.
Чем скорее вы включите тех. писателя в разработку, расскажете ему ТЗ и желаемый результат – тем качественнее будет составлен документ.Отсутствие коммуникации, фидбека, желания разработчиков описать свою деятельность.
Говорил выше про то, что инструкции идут в ящик.Нереалистичные обращения и просьбы.
Если вам нужно что-то помимо инструкций – это к другому человеку. Это крупная тема для отдельной статьи, но если вкратце:Если нужно описать интерфейс – отдельный вид писателя: UX-writer. Если нужен привлекающий текст – копирайтер-маркетолог.
Если что-то юридическое-бухгалтерское – юрист-бухгалтер и нужен.
Если по ГОСТу начертить что-то, а потом расписать – инженер, связанный с конструированием.
Нет единой точки входа-выхода документации.
Просьбы-задачи летят со всех концов кому угодно. От этого очень теряется продуктивность у всего коллектива.
Драма и проблематика
Итак, давайте в качестве предмета обсуждения сегодня возьмём нашумевшее несколько месяцев назад обращение владельца компании при единовременном увольнении множества сотрудников:
Здесь я не буду обсуждать моральную сторону вопроса. Её уже тысячу раз разобрали, да и не эксперт я в этикете.
Скажите, больновато ли глазам читать? Согласитесь, какой-то эффект зловещей долины – вроде бы человек пишет на твоём языке, но как-то жутковато.
Поверьте, ваш мозг может подсознательно избегать всех этих ошибок. Вся орфография и грамматика, уверен, в вас уже есть со школы. Просто где-то запрятана, так сказать, в «чертогах разума».
Вы же не хотите, чтобы ваши сообщения выглядели как у этого парня ниже?
Это всё хиханьки-хаханьки, конечно, но становится грустно, если вы – предмет насмешек. Серьезных дел с вами вести точно не будут.
Давайте устроим интерактив? Накидайте себе в «блокноте», какие ошибки вы видите в тексте изначального письма, не заглядывая в мой список ниже. Затем, как напишете – сравните с моим в комментариях?
Итак, список проблем письма, разосланного сотрудникам при их увольнении. Без сортировки, просто экспромтом:
Кириллица в англицизмах.
«Биг дата» — большая натяжка, «жира, гугл почта, иксолла» — совсем не то.
Вы спросите, а как понять, как можно, а как нельзя? Честно, я и сам уже многие годы задаюсь вопросом, почему «USB» мы пишем так, а не «ЮСБ», а «СМС» допускается писать кириллицей.Самый простой способ избежать ошибки – гуглить на предмет используемости.
Можно также использовать Reverso Context или Microsoft Language Portal — здесь можно найти перевод терминов в контексте. Как на русском, так и на английском. Просто можно брать самый употребляемый вариант того или иного термина.
Обвинение в первом сообщении.
Понимаю, что в переписке, хоть личной, хоть деловой – тяжело избегать эмоций. Но, согласитесь, вам же самим приятно, когда вас не осуждают и не выдвигают претензий с порога.Субъективизм.
«Невовлеченные» и «малопродуктивные» — это по каким критериям?На любом уровне, в любой профессии – следует избегать абстрактных свойств объекта. Если же применено какое-то свойство для сравнения – следует дать конкретные его показатели.
Предложения с маленькой буквы.
ну. маленькая буква она такая. вот уже на третьем-четвертом предложении чисто визуально всё сливается и становится тяжело читать. нашему подсознанию, как и вам, во время чтения вслух – нужны паузы. не очень же приятно, в сравнении с другими абзацами, не правда ли?Пунктуация в принципе.
Я про это скажу в конце – в лайфхаках. Здесь все всё понимают. Пару раз пролетели дефисы, запятые стоят наугад.Абзацы.
Второй абзац у человека явно сливается.Правил по этим абзацам – сойдёшь с ума. Однако, если вы продолжаете абзац с чем-то совсем отвлеченным от предыдущего предложения – может быть стоит совершить перенос?
Слоны – умные животные.
Согласитесь, если бы я написал про слонов в предыдущем абзаце – было бы не очень комфортно?
Орагнизовали. Опечатка.
Опечатки – это классика, от этого страдают все. Так что тут поможет внимательное чтение длинных и сложных слов в отдельности. Еще говорят, надо перечитать текст пословно с конца. Также, как это ни странно, это чуть ли не единственное, где хорошо помогает автокоррекция в Word.
Плохое попадание в аудиторию.
Такое делается иногда для того, чтобы показаться в обществе «плохим парнем», «хайпануть».Если бы аудитория из уходящих из компании сотрудников была учтена, проявлена мягкость и сказано, какие отступные люди получат, как человек сожалеет и у него рвётся сердце – ну разве этого лапочку не простили бы все сразу?
Не хочу раздувать список до миллиона пунктов и уходить совсем в духоту, на этом завершу.
Эпос и решения проблем
Я просто дам лайфхаки, они совсем лёгкие, как решить бóльшую часть ваших проблем. Даже без привязки к обозреваемому письму выше:
Используйте фразеологизмы.
Честно, любая поговорка о волке или золотой рыбке, которая пришла вам через 0,1 секунды после анализа ситуации вокруг – выговорите её.Фразеологизмы очень часто помогают насытить речь «человечностью», вовлекают читателя-слушателя, а также помогают понять строение языка. Поверьте, это насытит вашу речь и очень хорошо «застимулирует» мозг.
Задавайтесь вопросами.
Если бы я был вашим инструктором по какой-нибудь практике и брал с вас 100 тысяч за сеанс в неделю, то порекомендовал бы разные варианты комбинаций вопросов «зачем?» «для кого?» и «как?», составленные в какую-нибудь красивую аббревиатуру.Перечитывайте сами себя.
Опечатки всегда смешно читать, но рано или поздно – надоест.Сохраняйте объективность и позитив.
Порой хочется как высказать что-нибудь такое. Поэмоциональнее. Но не стоит.Попытайтесь отойти от компьютера, выдохнуть, дать себе пару минут. Любое эмоциональное высказывание всегда грешит бóльшим количеством ошибок.
Хотя бы чуть-чуть нужна пунктуация.
И да, поверьте, в 99% случаев поставленная запятая лучше, чем не поставленная. Даже если это какое-нибудь совершенно идиотское исключение из правил – вслух-то мы сделали бы паузу. Вот так и в чтении – всё как будто вслух.А если начнёте уделять внимание более юрким дефисам – будете самым привлекательным в своем коллективе.
Чаще делите свой текст, используйте короткие предложения.
Этим страдают все. Большими предложениями. Их никто не любит. Краткие – любят все. Просто берёте свой текст, и, при перечитывании – рубите пополам. А то и на три-четыре части. Не представляете, как сильно вы свой текст облегчите.
Учитывайте аудиторию.
Для вас, дорогая аудитория Хабра – я надел одну маску. Инструкции пишу по-другому, с начальником общаюсь в третьей маске.
Где-то правила соблюдать нужно строже, перепроверив 10 раз. Где-то можно и побаловаться, не обременяя себя, зато выразиться более эмоционально.
Лирика: «Вместо заключения»
Ну, что, получилось у меня выполнить свои же установки?
Надеюсь, немножко о профессии я вам рассказал, ну и дал даже больше пары лайфхаков.
Закончу сравнением – вам же не очень хотелось бы садиться в сильно разваливающийся и грязный автомобиль, какой бы гонщик «формулы» не сидел за рулём?
Также и тут - видимой связи между вами и вашим отношением к жизни и мелочам, быть может, вы и не замечаете. Однако, вы же и сами чувствуете, когда к вам проявили заботу и написали сообщение безошибочно?
Всем счастья и благополучия, добра и личностного развития!
