Что я научился писать для разработчиков
В прошлом году я работал техническим писателем, создавая руководства и копии для разработчиков. За это время мне пришлось многому научиться на ходу, работая единственным писателем в команде.
То, что я был единственным писателем, означало, что у меня не было ни одного старшего писателя, чтобы спросить совета. Но работа с командой разработчиков дала мне другой взгляд на письмо и рабочее место, которое я не получил бы больше нигде.
Сделайте это правильно или сделайте быстро
Если менеджер запрашивает определенные функции на веб-сайте или клиент просит запустить его веб-сайт в течение ограниченного периода времени, иногда есть только два варианта. Сделайте это правильно или сделайте это быстро.
Это верно как для автора, так и для разработчика проекта. При создании документации или веб-сайта за день будут ошибки. Возможно, он едва функционирует. То или качественный товар будет поздно.
Но вам придется объяснить, что качественные продукты требуют времени и, надеюсь, ваши ожидания изменятся.
У всех есть черновики
Не только писатели имеют черновики, и никто никогда не понимает их с первого раза.
Для разработчиков будут ошибки, неуместные функции и ошибки, которые не будут очевидны до тех пор, пока не будут реализованы. А для аналитиков и тестировщиков рабочие процессы, демонстрации и презентации всегда будут нуждаться в доработке.
Внезапно быть писателем пятого черновика стало уже не так уж плохо.
Привыкайте к переменам
В моем офисе было несколько случаев, когда весь дизайн веб-сайта отменялся по прихоти, и разработку приходилось начинать заново.
И мое письмо тоже не застраховано от этого.
Вы знаете то руководство, которое вы писали последние два месяца? К черту, проект отменен; вот еще один проект, который нам нужен к завтрашнему дню.
Копию написали для раздела сайта? Сейчас все не так, изменился функционал.
Ожидания и планы могут измениться на лету без причины и в короткие сроки. Но это часть игры, и вам нужно адаптироваться к изменениям и обуздать любые разочарования.
Все дело в команде
Письмо может быть очень уединенной ролью. Но на самом деле так быть не должно.
Даже если некоторые разработчики не очень общительны, работа все равно требует общения с командой. Любой, кто страдал от ежедневных встреч, знает это.
Это то, что я пытался применить к письму.
Писатели могут оставаться в своих комнатах со всеми своими документами и исследованиями и никогда ни с кем не разговаривать. Но даже если в этом нет необходимости, стоит поговорить с другими людьми, чтобы получить представление и понимание. Может помочь простой разговор о проекте или о чем-то, не связанном с работой.
Говорить вслух может действительно помочь организовать ваши мысли, и, по крайней мере, построение отношений с вашей командой значительно упростит совместную работу.
Лучше всего работать, когда вы общаетесь с редакторами, сотрудничаете с профильными экспертами и обсуждаете требования с клиентами.
Бюрократы везде
Если вы устроились на работу в сфере технологий в надежде, что не будете иметь дело с бюрократами компании и невежественными клиентами, вы сильно ошибаетесь.
По-прежнему будут поступать менеджеры и клиенты, которые не понимают кодирования и не имеют реалистичных сроков реализации проектов, и вам все равно придется иметь дело с этим.
Единственная разница в том, что вы будете солидарны со своей командой и связаны тем фактом, что вы в ней вместе.
Ничего страшного, если ты не знаешь всего
Но нужно знать, как найти ответ. Просить помощи у товарища по команде - это нормально, но вы не можете обращаться к нему каждые пять минут, когда сталкиваетесь с препятствием.
Или, если вы похожи на меня, может быть, не к кому пойти.
Возможность найти ответ на проблему может быть гораздо ценнее, чем знание. Он демонстрирует инициативу, находчивость и умение решать проблемы.
В какой-то момент возникнет проблема, на которую ни у кого нет ответа, но вы можете решить ее, если знаете, как и где искать.
Иногда ответ - через поиск в гугле. В других случаях это можно найти в проектной документации или в справочниках компании. Но ответ есть. Тебе просто нужно его найти.
Каждый раз, когда вы находите ответ, записывайте его и то, где вы его нашли.
В конце концов, вы можете оказаться тем, к кому люди приходят за ответами.
Не относитесь к себе так серьезно
Иногда разработчику требуются часы, чтобы прочесать код, чтобы попытаться исправить ошибку, только чтобы обнаружить, что это простая строчка, которую нужно исправить, и посмеяться над ней. Именно это легкое жестокосердие и неконкурентоспособность действительно заставили меня увидеть, насколько непринужденной может быть работа.
В моем письме будут неуместные запятые и опечатки. Это данность почти каждому писателю. Однако это не обязательно означает, что вам не хватает навыков. Это может означать, что вам нужно практиковать свои навыки редактирования текста, но даже у самых талантливых писателей есть редакторы. Не стоит терять голову.
Хотя могут возникнуть огромные нагрузки, это не значит, что каламбуры и дебаты о звездных войнах должны прекратиться. Потому что, в конце концов, каждый любит свою работу и знает, что он часть команды - хорошо это или плохо.