Я узнал, что существуют технические писатели, как им стать и как понять, что мне это подходит? Какие навыки подтянуть?

Я узнал, что существуют технические писатели, как им стать и как понять, что мне это подходит? Какие навыки подтянуть?


Я узнал, что существуют технические писатели, как им стать и как понять, что мне это подходит? Какие навыки подтянуть?

Ответ на этот вопрос можно разделить на несколько направлений и нужно четко понимать, что профессия технического писателя - очень широкая, здесь и архитектурная документация, и документирование API, и собственно пользовательская документация, и тексты в интерфейсе и многое другое и для каждого набор навыков немного отличается, однако есть и общие.

Во-первых, это мягкие скиллы, которые сложно накачать, но которые необходимы любому техническому писателю.

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

Затем – желание учить, объяснять, давать инструкции и учиться самому. Любознательность и желание разбираться в деталях – важное качество. Если у вас есть опыт преподавания или даже репетиторства – возможно это ваша история.

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

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

Во-вторых, базовые технические навыки, такие как знания по сетям, операционным системам, протоколам, архитектурным паттернам их набор отличается в зависимости от компании, где предстоит работать и аудитории, для которой вы будете писать – внешние пользователи или внутренний (разработчики, тестировщики, пиэмы). Тут хорошее подспорье - это Гарвардский курс CS50 по основам компьютерных наук и курс Technical Support от Google на Coursera, они позволяют вспомнить основы.

Сюда же относится знание процесса разработки программного обеспечения, какие стадии он проходит, как устроены продукты и т.д. Тут неплохим подспорем могут быть книги по тестированию ПО, например, Роман Савин Тестирование DOT COM. Не смотрите на название, книга позволяет понять устройство программных продуктов.

В-третьих, это знание инструментов разработки документации, их нескольк десятков, сразу бросаться учить все - неэффективно. Но стоит хотя бы ознакомиться с основными легковесными языками разметки (MarkDown, RST), инструментами сборки и реализации технологии единого источника (DITA, DocBook), посмотреть что такое AuthorIT, MadCap, узнать о концепции docs as code.

В-четвертых, собственно знание языка и правил построения текста. Для русского языка многие компании котируют концепцию лаконизма Максима Ильяхова, редактора ресурса Главред, прочитать его "Пиши, сокращай" как минимум стоит, но лучше пропустить через себя и делить минимум на 1.5.

Для английского языка стоит ознакомиться со стилем Simplified Technical English, узнать, чем технический английский отличается от обычного разговорного или делового.

Здесь могут помочь стандарты, такие как Chicago Manual of Style и Microsoft Manual of Style, они очень объемные и описывают все возможные кейсы применения слов, предложений, пунктуации, терминов. Каждая компания адаптирует их под себя. Обычно их используют, чтобы решить конкретный вопрос, как пишется то, как оформлять это.

Но самый лучший источник – это живая документация, откройте и почитайте публичную документацию крупных компаний, например, Google, Microsoft, Amazon. Подумать, что в ней хорошего, а что вы бы исправили.

Этих направлений в развитии на первые несколько месяцев вполне достаточно.

Самопроверка

Попробуйте взять какой-то распространенный технологический концепт, например, протоколы HTTP и HTTPs, стандарты IPV4 или IPV6, DNS, и описать его, придумав, для какой аудитории вы пишете и зачем. Дайте кому-нибудь почитать, спросите, понял ли он.

Что еще почитать/посмотреть, чтобы узнать о профессии и базовых навыках?

  • Курс English 305 Advanced Technical Writing на Study.com
  • Курсы от компании http://documentat.io/courses/, проходят в основном в Новосибирске, но один будет 8-9 октября в Москве. Пока что можете посмотреть записи транслчций с очного курса для новичков на Youtube, даю ссылки на первые две лекции https://www.youtube.com/watch?v=KGVeeKhio70, https://www.youtube.com/watch?v=0j0AY1ckzHo
  • книга Technical Writing 101 Alan Pringle, Sarah O'Keefe, ее и другие книги по профессии можно посмотреть вот в этом каталоге книг по технической коммуникации, собранном энтузиастами https://docs.google.com/spreadsheets/d/11O1SaTrM3MlOVB9Z_Fx63iPpqaivdT2gjQg4ogCPwzQ/edit?usp=drivesdk