Вы новичок в написании технических статей или думаете о том, чтобы начать? Ключ к успеху — признание того, что технические писатели — необходимое зло.
Технические писатели необходимы, потому что кто-то должен писать пользовательскую документацию.
Программисты и менеджеры уж точно не хотят. На самом деле это одна из причин того, что вы тоже злой.
По моему опыту, большинство программистов и менеджеров думают, что могли бы написать руководства, если бы захотели… но они этого не хотят. Возможно, они не пишут все «цветисто», как технические писатели, но то, что они пишут, правильно.
К сожалению, зачастую это все, что важно для программистов и менеджеров.
В среде программного обеспечения существует мнение, что точность = качество.
Анализ аудитории, читаемость документации, последовательность, удобство использования, активный и пассивный залог, запятые в списке из трех и более пунктов… Все эти вещи относительно неважны для всех, кроме технического писателя.
Ох… и пользователь.
В мире, где точность имеет решающее значение, многое выходит за рамки головы манекена.
Не знаю, интеллектуальный ли это снобизм, но программисты и менеджеры, кажется, думают, что если они это понимают, то и пользователь тоже должен это понимать.
Неважно, делают они это или нет… они ДОЛЖНЫ! Глупые пользователи! Возможно, это высшая месть гика.
Ваш документ может быть на 100% точным, но если аудитория не сможет его прочитать, вы зря потратили время.
Так почему же никто этого не признает? Они делают! Это самая странная часть.
В теории все с тобой согласны, просто на практике оказываешься в дураках.
Я не знаю, почему это происходит. Возможно, это потому, что большинство этих ребят никогда не занимались техническим писанием.
Поэтому технические писатели слишком долго беспокоятся о неважных вещах.
И они беспокоят программистов и менеджеров неважными вещами.
Но это необходимые вещи.
Иначе зачем бы вас трудоустроили.
Возможно, отсутствие простой логики замыкает их мозги.
Кто знает? Что мы можем из этого извлечь, так это то, что возникает ощущение, что технические писатели тратят время зря, и в результате они находятся в значительной степени на дне кучи в мире программного обеспечения.
Я думаю, что хорошая аналогия — это то, как некоторые богатые видят бедных.
Грязные твари.
если бы можно было обойтись без них.
Но есть и положительная сторона.
Я не хочу, чтобы ты думал, что все плохо.
Нахождение в нижней части кучи имеет свои преимущества.
При желании вы можете оставаться незамеченным в течение многих лет. Если вы еще не смотрели фильм «Офисное пространство», вам следует взять его напрокат. В нем есть маленький хорек, которого «отпустили» много лет назад. Проблема в том, что ему никто так и не сказал, а из-за сбоя в расчете заработной платы ему все равно заплатили.
Никто никогда не замечал.
Быть техническим писателем примерно так же.
Когда я руководил командами разработчиков, моей любимой поговоркой было: «Все, что нам нужно делать, — это управлять их ожиданиями и нашими обязательствами».
Поскольку программисты и менеджеры смиряются с тем, что не знают, что происходит в команде документаторов, иногда возникает искушение расслабиться.
Не поддавайтесь этому искушению!!! Если вас когда-нибудь поймают за этим занятием, это будет похоже на мальчика, который кричал: «Волк» — они никогда больше не поверят вашим оценкам! Другой риск заключается в том, что вы потеряете чувство срочности.
И это большая часть того, что делает хорошего работника.
Вам следует очень строго относиться к выполнению своих обязательств.
Это требует дисциплины, потому что иногда кажется, что ты единственный, кто заботится об этом, но ты должен это сделать.
Однако вам следует знать одну вещь: средний технический писатель по программному обеспечению тратит только около 50% своего времени на написание статей.
Остальное время вы тратите на планирование, решение проблем, ремонт компьютера, исследования, интервью с программистами, написание рабочих практик… Однако я всегда находил это хорошим балансом.
Когда я начал управлять командами, дно действительно упало.
Затем процент упал примерно до 10-20%.
Были времена, когда я месяцами вообще не писал никакой помощи.
Это может очень расстраивать, особенно если вам не особенно нравится управлять.
Теперь управлять техническими писателями в области программного обеспечения — интересная вещь.
Как и в случае с большинством должностей в области управления технологиями, вы как бы попадаете на эту должность, потому что вы самый старший и опытный человек в компании.
К сожалению, это не дает вам права быть менеджером.
Компании-разработчики программного обеспечения известны тем, что бросают людей на руководящие должности без какой-либо реальной подготовки или поддержки.
Здесь у меня нет для вас никаких советов.
Если это произойдет, то это произойдет. Просто помните об этом и знайте, что если вы возьмете на себя руководящую роль, это будет сложно.
(Хотя это не значит, что это не может быть полезным.
) Ирония в том, что самым трудным аспектом является то, что ваши сотрудники кричат вам, чтобы вы изменили систему.
«Программисты не отвечают на наши вопросы!» «Ни одна моя работа не была проверена за последние 2 месяца!» «Руководитель проекта только что сказал мне забыть о качестве!» К сожалению, неопытные технические писатели часто настолько наивны, что думают, что смогут изменить систему.
Став менеджером, вы поймете, что не сможете.
Подождите минутку.
Возможно, именно апатия делает вас менеджером.
Хмммм.
В любом случае, мой совет – не переусердствовать.
Вы усложните жизнь своему руководителю и создадите себе плохую репутацию.
Осознайте, что вы — необходимое зло, и работайте в рамках этих ограничений.
Техническое письмо может доставлять массу удовольствия.
И не позволяйте никому говорить вам, что это не креативно.
Попытка придумать способ описать то, что находится в поле «Имя», не просто сказав «Введите имя», — это настоящая головоломка!
Кто хочет быть хорошим в чем-то только потому, что это его работа? Почти никто не захочет вкладывать всю работу по написанию полезных и точных технических документов только для того, чтобы заработать зарплату, даже если это действительно зарабатывает на жизнь. Придавать такое большое значение их работе кажется неправильным.
Те, кто сделал на этом карьеру, верят в важность продукта и тестируют его. Все группы поддержки собрались вместе, чтобы тренировать тебя. Ни один принцип не был извинением и не требовал от вас чего-либо, кроме жертвы ради обучения. В конце концов, однако, они протягивают вам лопату, потому что они в своих цветах и смотрят в космос, чтобы найти что-то большее и более значимое, чем то, что может дать земля. Почему? Это потому, что определяющая их профессиональная деятельность не связана с их средствами к существованию. Обязаны ли мы им такой же преданностью? Достаточно ли мы хороши в своей работе сборщиков счетов или веб-дизайнеров, чтобы нам просто платили? Вы видите мир по-другому. Сильное стремление знать больше, приобретать большее понимание и постоянно развиваться. Это совершенная черта; типичный инстинкт – и он нужен нам прямо сейчас.
Вам нужно помогать всем в комнате, включая руководство, но будьте настолько необходимы, насколько вас познакомили с вашей новой должностью. Люди, привыкшие к вам и ценящие важные сведения, должны приветствовать вас. Поэтому, возможно, пришло время подготовиться и использовать свои инстинкты, чтобы помочь тем, чей путь вы исказили. Будьте дотошны, обстоятельны, внимательны, при необходимости оттачивайте письменное общение, общайтесь со всеми устно и неофициально так, как вам будет удобнее. Что еще более важно, получайте зарплату, делайте все необходимое, чтобы не отставать и способствовать своему росту. Начните свой собственный бизнес в области веб-дизайна в выходные дни. Время стать самим себе авторитетом и строить от своей короны, от пола до потолка.
-
Взгляд В Прошлое Геотермальной Энергетики
19 Oct, 24 -
Выбери Жизнь: Хвалебная Речь Моей Матери
19 Oct, 24 -
Первая Течка У Тибетского Мастифа
19 Oct, 24 -
Образец Квитанции На Оплату
19 Oct, 24
