Профессия "Технический писатель", или "Рыцари клавиатуры" - [8]

Шрифт
Интервал

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

Четвёртая причина — для каждого своя, поскольку любой «нетекстовый» специалист всё равно вынужден писать много разного. Так, тимлидер ставит задачи своим подчинённым, программист комментирует код и, при появлении нового коллеги, вводит его в курс дела, тестер пишет отчёты о тестировании, инженер поддержки формулирует запросы на доработку или исправление ошибок на основании пользовательских запросов, маркетолог собирает данные о продукте, чтобы лучше знать, как его продвигать. Этот список можно продолжать бесконечно, ведь так или иначе работать с текстами как средством коммуникации приходится всем.

Сказанное выше однозначно отвечает на вопрос о необходимости навыков разработки текстов, хотя бы базовых, для всех сотрудников предприятий, работающих в сфере сложного производства и высоких технологий.


5. Почему инженер или программист не может писать технические тексты?

 Стоп! А разве в прошлом разделе не говорилось о том, что навыки разработки текстов нужны всем, а значит и писать, в конечном итоге, могут все? А тут вдруг раз — и не могут, тем более — сами разработчики и программисты. Это как?

Чтобы разобраться в этом вопросе, для начала стоит разобраться, о каких именно текстах идёт речь в случае техписов и всех остальных технарей.

Как следует из предыдущего раздела, для большинства IT-специалистов (тестировщиков, программистов, системных аналитиков, инженеров и многих других) умение внятно и лаконично излагать свои мысли становится залогом облегчения коммуникаций внутри компании. Способность донести до коллег необходимую информацию, поставить задачу сотруднику, разработать понятное всем описание результатов тестирования, прокомментировать собственный код, чтобы его восприятие коллегами-программистами было максимально быстрым и полным — именно эти цели преследуются ими при освоении навыков документирования. В их профессиональные задачи не входит разработка непосредственно документации «от и до». Их основное занятие — писать программы, разрабатывать оборудование, проводить тестирование, внедрение — да что угодно, в зависимости от должности, но никак не создание пользовательских и прочих руководств.

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

Что же до технических писателей — то для них тексты являются основной областью деятельности, а их основные «клиенты» — не коллеги из разных отделов, а пользователи разрабатываемого компанией продукта или программы.

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

Но почему так важно делить эта два направления — внутреннее и внешнее? Почему нельзя отправить самого разработчика документировать собственное детище? Причин две.

Первая — разумное использование времени. Программист быстро и качественно пишет код программы, техпис — текст документации. Но если заставить программиста писать документацию — он будет корпеть надо ней значительно дольше, чем технический писатель, а время — это деньги. Написание программистом документации смотрится, на самом деле, ничуть не лучше, чем техпис, разбирающийся в программировании, который пишет программу — да, он её напишет, но потратит уйму времени и код, скорее всего, будет далёким от идеала и вообще не оптимизированным.

Вторая — умение писать тексты и документацию — не тождественные понятия. Внутри компании — люди, полностью знающие продукт, а за её пределами — клиенты, которые о нём не имеют представления. И, как показывает практика — разработчики продукта не могут качественно описать его для постороннего пользователя. Их можно долго и упорно учить, тренировать, из них можно сделать техписов (если очень хочется и совсем нечего больше делать), но свою собственную разработку они даже в таком случае не смогут качественно описать. Это проверенная десятилетиями истина, которую невозможно изменить. И можно даже привести простой пример — если вас попросят описать своих родителей, вы вряд ли выдадите что-то объективное и членораздельное. Да, вы знаете их «от и до», буквально всё о них, но описать их вам не удастся — в голове будет столь много мыслей, что наружу (помимо дежурного «Э...») прорвётся всего одна-две из них.


Рекомендуем почитать
История инженерного дела. Важнейшие технические достижения с древних времен до ХХ столетия

Настоящая книга представляет собой интереснейший обзор развития инженерного искусства в истории западной цивилизации от истоков до двадцатого века. Авторы делают акцент на достижения, которые, по их мнению, являются наиболее важными и оказали наибольшее влияние на развитие человеческой цивилизации, приводя великолепные примеры шедевров творческой инженерной мысли. Это висячие сады Вавилона; строительство египетских пирамид и храмов; хитроумные механизмы Архимеда; сложнейшие конструкции трубопроводов и мостов; тоннелей, проложенных в горах и прорытых под водой; каналов; пароходов; локомотивов – словом, все то, что требует обширных технических знаний, опыта и смелости.


Юный техник, 2015 № 04

Популярный детский и юношеский журнал.


Юный техник, 2015 № 03

Популярный детский и юношеский журнал.


Юный техник, 2014 № 02

Популярный детский и юношеский журнал.


Столярные и плотничные работы

Умение работать с благородным материалом – деревом – всегда высоко ценилось в России. Но приобретение умений и навыков мастера плотничных и столярных работ невозможно без правильного подхода к выбору материалов, инструментов, организации рабочего места, изучения технологических тонкостей, составляющих процесс обработки древесины. Эта книга покажет возможности использования этих навыков как в процессе строительства деревянного дома, так и при изготовлении мебели своими руками, поможет достичь определенных высот в этом увлекательном и полезном процессе.


Технический регламент о требованиях пожарной безопасности. Федеральный закон № 123-ФЗ от 22 июля 2008 г.

Настоящий Федеральный закон принимается в целях защиты жизни, здоровья, имущества граждан и юридических лиц, государственного и муниципального имущества от пожаров, определяет основные положения технического регулирования в области пожарной безопасности и устанавливает общие требования пожарной безопасности к объектам защиты (продукции), в том числе к зданиям, сооружениям и строениям, промышленным объектам, пожарно-технической продукции и продукции общего назначения. Федеральные законы о технических регламентах, содержащие требования пожарной безопасности к конкретной продукции, не действуют в части, устанавливающей более низкие, чем установленные настоящим Федеральным законом, требования пожарной безопасности.Положения настоящего Федерального закона об обеспечении пожарной безопасности объектов защиты обязательны для исполнения: при проектировании, строительстве, капитальном ремонте, реконструкции, техническом перевооружении, изменении функционального назначения, техническом обслуживании, эксплуатации и утилизации объектов защиты; разработке, принятии, применении и исполнении федеральных законов о технических регламентах, содержащих требования пожарной безопасности, а также нормативных документов по пожарной безопасности; разработке технической документации на объекты защиты.Со дня вступления в силу настоящего Федерального закона до дня вступления в силу соответствующих технических регламентов требования к объектам защиты (продукции), процессам производства, эксплуатации, хранения, транспортирования, реализации и утилизации (вывода из эксплуатации), установленные нормативными правовыми актами Российской Федерации и нормативными документами федеральных органов исполнительной власти, подлежат обязательному исполнению в части, не противоречащей требованиям настоящего Федерального закона.