paint-brush
Техническое письмо для стартапов важно: вот почемук@theankurtyagi
740 чтения
740 чтения

Техническое письмо для стартапов важно: вот почему

к Ankur Tyagi9m2023/10/29
Read on Terminal Reader

Слишком долго; Читать

Техническое письмо играет важную роль в успехе стартапа. Это предполагает создание четкой, краткой и ориентированной на пользователя документации, объясняющей, как работает продукт или услуга.
featured image - Техническое письмо для стартапов важно: вот почему
Ankur Tyagi HackerNoon profile picture
0-item


Добро пожаловать в первую публикацию в нашей новой серии « Как техническое письмо может ускорить ваш стартап ».


В этой серии я покажу вам, как техническое письмо может принести пользу стартапам: от повышения известности до укрепления доверия со стороны вашей аудитории. Как поставщик услуг по написанию текстов для стартапов, я видел положительное влияние, которое может оказать хорошо продуманный контент.


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


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


Написание программного обеспечения — это что-то среднее между написанием романа и построением моста.


Техническое письмо терпит и даже поощряет стилистические особенности, которые традиционные публикации не допускают. Наклонитесь к ним.


Технический контент либо своевременен, либо вневременен, и между ними почти нет ничего.


состояние отношений с застройщиками-2023


Изображение предоставлено «Состояние отношений с разработчиками». Полный отчет можно найти здесь.


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


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


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


Помните: медиаформаты цикличны. Ницше писал афоризмами, а Твиттер — это афоризмы как услуга. Хип-хоп вернул поэзию. Монтень был пионером формата эссе, а блоги вернули его в моду.


Стартапам следует писать больше манифестов, блогов, чистой документации и руководств по интеграции.



нанимайте людей, которые пишут хороший технический контент


Что такое техническое письмо?

За последние 3 года я работал над документацией, руководствами по интеграции и техническими публикациями в блогах для более чем 20 стартапов. Я начал вносить свой вклад, когда работал защитником разработчиков в SuperTokens — альтернативе Auth0, Firebase Auth, еще в 2021 году, и помогал разработчикам перейти на новую аутентификацию пользователей с открытым исходным кодом.


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

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


GPT показал, насколько письмо является чистой ерундой. Блеклый, безжизненный, бессмысленный, безобидный и не стоящий тех чернил, которыми он был напечатан. поэтому хорошие писатели станут более важными для ваших стартапов, которые смогут создавать и писать отличные технические блоги, а плагиат ChatGPT не является проблемой. Если вы не можете написать лучше машины, что вы пишете?


Если вы разработчик и заинтересованы в написании технических блогов, я написал целый специальный блог о том , что такое техническое письмо и как писать хорошие технические блоги .


Мои принципы письма

При написании технических текстов я всегда стараюсь помнить о следующих принципах.

  • Цель написания — сделать задачи максимально простыми и эффективными для пользователей.
  • Разработчики предпочитают, чтобы им показывали, а не рассказывали, и предпочитают учиться на практике.
  • Помогите своим пользователям достичь первого успеха как можно скорее.
  • Будьте проще и пишите простым языком.

Почему техническое письмо важно для стартапов?

Я пишу технический контент последние 3 года. Вот что я узнал:

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

  • Тщательное техническое письмо показывает, что вы серьезно относитесь к своему продукту и своим пользователям. Это повышает доверие и уверенность вашего бренда.

  • Новые конечные пользователи могут быстро освоить ваш продукт, если у них есть доступ к хорошо организованным и понятным руководствам, интеграции и документации.

  • Хорошо структурированные технические блоги и документация улучшают SEO вашего сайта, помогая потенциальным клиентам легче вас найти.

  • По мере роста вашего стартапа вам потребуется нанимать больше сотрудников. Хорошее техническое письмо и документация необходимы для эффективного обучения новых сотрудников.

  • Вот несколько примеров отличных инженерных блогов:

  • Блог Cloudflare

  • Инженерный блог DoorDash

  • Технический блог Netflix


Техническое письмо — технический блог Netflix


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

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

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

  • Наличие превосходных технических блогов и документации может стать существенным преимуществом, давая вам преимущество перед конкурентами.



Хорошее техническое письмо = органический маркетинг для разработчиков

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


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


Разнообразие инструментов разработчика резко возросло: от IDE до абстракций более высокого уровня и платных сервисов, таких как GPT, включая инструменты low-code.


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


Почему технический контент важен для стартапов


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


Разработчики присутствуют на таких платформах, как X (ранее Twitter), Hacker News, Reddit и LinkedIn, и любят читать хорошо написанные технические статьи в блогах.


Почему стратегия технического письма выделяется?

Хотя я признаю, что крупные технологические компании и стартапы становятся все лучше в привлечении разработчиков. Прежде чем начать свой блог в качестве разработчика маркетинга, я проработал 13 лет практическим инженером-программистом и техническим руководителем, поэтому вот мои мысли о том, почему техническое письмо является большим преимуществом для стартапов.


Маркетинг «бизнес для разработчиков» («B2D-маркетинг») описывает маркетинговые инициативы, предназначенные для охвата разработчиков, и технические статьи — один из лучших способов сделать это, оставаясь при этом искренними, достоверными и интересными.


Многие стартапы испытывают трудности с техническим маркетингом B2D, потому что с разработчиками труднее связаться, чем со средним потребителем. Такие уловки, как сувениры, купоны на бесплатную еду, бесплатные футболки или эксклюзивные мероприятия, посвященные алкоголю, — не лучший вариант.


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

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


Мы все разработчики ценим честность. В последнее время мне лично понравилась страница блога Supabase . Они написали несколько очень крутых блогов и добились очень хорошего роста благодаря своему письменному контенту.


Supabase-Блог


Для стартапа это означает, что вы должны быть честными в отношении своего продукта перед сообществом.


theankurtyagi-блог


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


У крупных технологических компаний, таких как Google/Amazon/Meta/Netflix, есть команды из этих людей, которые выступают с докладами на конференциях, проводят тренинги и пишут технический контент о продуктах своей компании, но роль защитника разработчиков не подходит для большинства стартапов. потому что им приходится действовать быстро, и, к сожалению, многие защитники разработчиков ленивы и люди ниже среднего.


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


2023-devrel-отчет


Стартапы должны использовать технические тексты и документацию в качестве инструментов маркетинга .


Изображение предоставлено «Состояние отношений с разработчиками». Полный отчет можно найти здесь.

Роль технического письма в эффективной коммуникации

Мы можем написать множество различных типов технического контента для разработчиков программного обеспечения.

  • Документация важна, но очень немногие стартапы используют документацию в качестве маркетингового канала.
  • Учебники и практические руководства помогут конечным пользователям увидеть, как использовать ваш продукт в реальном мире.
  • Контент, повышающий узнаваемость , создается с целью повышения верхней части вашей воронки и может публиковаться на сайтах внешних партнеров для увеличения охвата. Hashnode, DevTo, HackerNoon и DZone — это бесплатные места для публикации контента для разработчиков.
  • Сообщения в блогах на вашем веб-сайте позволяют привлечь читателей и увеличить количество регистраций.
  • Спонсируйте независимых писателей или старшего инженера, который ведет технический блог на своем веб-сайте или в информационных бюллетенях.

Как техническое письмо обеспечивает ясность и понимание

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


Моя тактика публичного письма:


Кто-то недавно в моем личном сообщении в Твиттере спросил меня: «Привет, Анкур, я большой поклонник твоего блога, но у меня есть вопрос: как ты относишься к публичной публикации? Люди в Интернете иногда такие придурки».


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

Всегда говорите о реальных фактах и ​​будьте честны

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

Редактировать и рефакторить ошибки

Я делаю много ошибок в своих сообщениях в блоге, потому что пишу о многих вещах, которые находятся на грани моих знаний. Когда люди указывают на ошибки, я редактирую сообщение в блоге и исправляю его. Обычно я остаюсь возле компьютера в течение нескольких часов после публикации сообщения в блоге в своем Twitter или ленте LinkedIn, чтобы иметь возможность быстро исправлять ошибки по мере их возникновения.

Преодоление разрыва в технических знаниях: основная задача программы по связям с разработчиками стартапов

В отчете об опросе упоминается, что разработка контента была основным видом деятельности для специалистов по связям с разработчиками в 2023 году, при этом проводится различие между разработкой контента, связанного с образованием (55%), и разработкой технического контента, такого как документация (50%). Это подчеркивает важность написания технических статей и создания контента для взаимодействия и обучения сообществ разработчиков.


2023-devrel-отчет


3 главных вопроса, которые должен задать каждый стартап перед запуском технического блога

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

Задайте эти вопросы, если вы начинаете новый блог для своего стартапа.


  • цель написания

  • целевая аудитория

  • тип контента, который будет создан


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


Вот и все для этого блога. Я продолжу писать на эту тему и поделюсь более подробной информацией о более конкретных функциях в следующем блоге.


Оставайтесь с нами. А пока вот некоторые из моих самых популярных блогов, которые вы, возможно, захотите прочитать.


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


Также опубликовано здесь .