740 測定値

スタートアップにとってテクニカルライティングは重要: その理由は次のとおりです

に Ankur Tyagi9m2023/10/29

長すぎる; 読むには

テクニカルライティングはスタートアップの成功において重要な役割を果たします。これには、製品やサービスがどのように機能するかを説明する、明確かつ簡潔でユーザー中心のドキュメントを作成することが含まれます。

featured image - スタートアップにとってテクニカルライティングは重要: その理由は次のとおりです

新しいシリーズ「テクニカルライティングでスタートアップを加速させる方法」の最初のブログ投稿へようこそ。

このシリーズでは、知名度の獲得から聴衆との信頼関係の構築まで、テクニカルライティングがスタートアップ企業にどのようなメリットをもたらすかを説明します。スタートアップ企業にライティングサービスを提供する者として、私はよく練られたコンテンツがポジティブな影響を与えることを見てきました。

今日は、テクニカルライティングがスタートアップの成長をどのように促進できるかについて概要から始めます。スタートアップにとってライティングが重要なツールである理由については、今後の投稿にも注目してください。

テクニカルライティングはスタートアップの成功において重要な役割を果たします。これには、製品やサービスがどのように機能するかを説明する、明確かつ簡潔でユーザー中心のドキュメントを作成することが含まれます。「強い意見も弱い意見。自分をさらけ出し、賢くて敬意を持った人々からの反対意見を常に探し続けてください。

ソフトウェアを書くことは、小説を書くことと橋を架けることの中間にあります。

テクニカルライティングは、従来の出版では対応できなかった文体の特異性を許容し、さらには奨励します。それらに身を乗り出してください。

技術的な内容はタイムリーかタイムレスかのどちらかであり、その間にはほとんど何もありません。

画像クレジット - 「開発者との関係の現状」 - ここから完全なレポートにアクセスできます。

組織/スタートアップにおいて計画を書き留める人物は非常に大きな力を持っています。テクノロジー企業の新進気鋭の人材を見つけたい場合は、誰が計画を書いているかを調べてください。すべてのアイデアを思いつくわけではないかもしれませんが、彼らにはアイデアを整理して書面で伝えるためのエネルギー、モチベーション、スキルがあることがわかります。

あなた自身とあなたのスタートアップの周りを、あなたの製品やサービスに含まれるあらゆるものについてさまざまな視点を考え出さずにはいられない「水平思考者」に囲まれてください。それらは常に正しいとは限りませんが、常にあなたの思考と執筆に挑戦します。

テクニカルライティングへの投資は、スタートアップの成功に大きな影響を与える可能性があります。ユーザーに利益をもたらすだけでなく、社内業務の効率と有効性にも貢献します。目標は、対象読者にとって明確かつ簡潔で理解しやすいドキュメントを作成することであることを忘れないでください。その結果、ユーザーの満足度、ロイヤルティ、ビジネスの成長が向上します。

メディア形式は周期的であることに注意してください。ニーチェは格言で書きましたが、Twitter はサービスとしての格言です。ヒップホップは詩を持ち帰りました。モンテーニュはエッセイ形式の先駆者であり、ブログがエッセイ形式を再び流行させました。

スタートアップ企業は、より多くのマニフェスト、ブログ、クリーンなドキュメント、統合ガイドを作成する必要があります。

テクニカルライティングとは何ですか?

過去 3 年間、私は 20 社以上のスタートアップ企業のドキュメント、統合ガイド、技術ブログ投稿に断続的に取り組んできました。私は、2021 年にAuth0、Firebase Auth の代替となる SuperTokensで開発者擁護者としての役割を果たしている間に貢献を開始し、開発者が新しいオープンソースユーザー認証に移行できるよう支援しました。

技術的なブログやドキュメントを書くのが楽しいことに気づきました。他の人に利益をもたらす高品質の技術文書を作成することに満足しています。

私は長年にわたり、多くの技術文書やドキュメントを読んできました。私はすべてのエンジニアが書くべき理由について書き、メモをまとめました。これは、将来のキャリアの中で重要なポイントを思い出すのに役立つだけでなく、今書くことについて考えるのに役立つツールでもあります。

GPT は、どれだけの文章が純粋なパブルであるかを明らかにしました。当たり障りのない、活気のない、洞察力に欠け、不快感がなく、印刷されたインクの価格に見合う価値がありません。したがって、優れた技術ブログを構築して書くことができる優れたライターがスタートアップにとってより重要になるでしょう。ChatGPT の盗作はまったく問題になりません。マシンを書き換えることができないなら、何を書いているのでしょうか?

あなたが技術ブログを書くことに興味がある開発者であれば、私は技術文書とは何か、そして優れた技術ブログを書く方法について完全な専用ブログを書きました。

私の執筆原則

テクニカルライティングを行うとき、私は常に次の原則を念頭に置くようにしています。

書くことの目標は、ユーザーにとってタスクをできるだけシンプルかつ効率的にすることです。
開発者は、言われるよりも示されることを好み、実際にやって学ぶことを好みます。
ユーザーができるだけ早く最初の成功を達成できるよう支援します。
シンプルにして、シンプルな言葉で書きましょう。

なぜスタートアップにとってテクニカルライティングが重要なのでしょうか?

私は過去 3 年間、技術的なコンテンツを書いてきました。私が学んだことは次のとおりです。

明確な技術ブログとドキュメントは、エンドユーザーが製品を迅速かつ効率的に理解するのに役立ち、フラストレーションを軽減し、満足度を高めます。
徹底したテクニカルライティングは、製品とユーザーを真剣に考えていることを示しています。それはあなたのブランドの信頼と信用を高めます。
新しいエンドユーザーは、よく整理されたわかりやすいガイド、統合、ドキュメントにアクセスできれば、すぐに製品に習熟できます。
適切に構成された技術ブログとドキュメントは Web サイトの SEO を向上させ、潜在的な顧客が Web サイトをより簡単に見つけられるようにします。
スタートアップが成長するにつれて、より多くの従業員を採用する必要があります。新入社員を効率的にトレーニングするには、優れた技術文書と文書が不可欠です。
以下に、優れたエンジニアリングブログの例をいくつか示します。
Cloudflareのブログ
DoorDash エンジニアリングブログ
Netflix 技術ブログ

詳細な技術ブログやドキュメントは、考え抜かれた製品とビジネス戦略を持っていることを示しており、潜在的な投資家やパートナーにとって魅力的です。
技術ブログやドキュメントからのエンドユーザーからのフィードバックは、製品を改善し、混乱している領域を特定するために非常に貴重であることがよくあります。
よく書かれたブログやドキュメントは他の現地言語に簡単に翻訳できるため、より広範囲の世界中の読者にリーチすることができます。
優れた技術ブログやドキュメントを持つことは大きな差別化要因となり、競合他社よりも優位に立つことができます。

優れたテクニカルライティング = オーガニックデベロッパーマーケティング

開発者はマーケティングを嫌うという評判がありますが、それは必ずしも真実ではありません。

実際、開発者はあらゆる規模の企業内で購買力と尊敬を獲得しています。雇用主は、優秀な開発者を見つけて維持するのが難しいため、開発者の生産性と満足度を維持するためのツールに投資することの重要性を認識しています。

開発者ツールの種類は、IDE から高レベルの抽象化、ローコードツールを含む GPT などの有料サービスに至るまで、劇的に増加しました。

テクニカルライティングは、信頼性と読者の理解に根ざした成功する開発者マーケティング戦略です。スタートアップ企業は、オンラインでも対面でも開発者と時間をかけて、開発者のニーズや好みを把握する必要があります。

技術コンテンツは真に役立つ、教育的なものである必要があり、多くの場合、開発者仲間によって作成された方が効果的です。選択肢には、社内エンジニア、開発者擁護者、コミュニティ執筆プログラム、フリーランスライター、独立したソフトウェアエンジニア、私のようなライターが含まれます。

開発者は、X (旧 Twitter、Hacker News、Reddit、LinkedIn) などのプラットフォームに存在しており、よく書かれた技術的なブログ投稿を読むのが大好きです。

テクニカルライティング戦略が傑出している理由

一方で、大手テクノロジー企業や新興企業が開発者にアプローチするのがうまくなっているのは認めます。私は、マーケティング開発者としてブログを始める前に、実践的なソフトウェアエンジニアおよびテクニカルリーダーとして 13 年間を過ごしました。そのため、テクニカルライティングがスタートアップにとって大きな資産である理由について、私の考えをここにまとめます。

B2D マーケティング (「B2D マーケティング」)は、開発者にリーチするために設計されたマーケティングイニシアチブを指します。テクニカルライティングは、本物で本物で興味深いものでありながら、それを行うための最良の方法の 1 つです。

開発者は平均的な消費者よりもリーチするのが難しいため、多くのスタートアップは B2D テクニカルマーケティングに苦労しています。記念品、無料の食品クーポン、無料の T シャツ、またはアルコールを中心とした排外的なイベントなどの仕掛けは、望ましい方法ではありません。

興味を持ってください - ソフトウェアエンジニアリングの開発者からフィードバックを得るには、書くことが断然最速の方法です。
製品を使用してクールなプロジェクトを構築し、それについて書いてパブリックで共有し、フィードバックを取得して繰り返します。

私たち開発者は皆、誠実さを大切にしています。最近個人的に気に入ったのは、 Supabaseのブログページです。彼らは非常に素晴らしいブログをいくつか書き、書かれたコンテンツから非常に大きな成長を遂げました。

これは、スタートアップとして、コミュニティ内で自社の製品について正直である必要があることを意味します。

多くの大手テクノロジー企業は開発者アドボケート、つまりライブイベントで自社製品を宣伝する技術的背景を持つ人材を雇用しています。

Google/Amazon/Meta/Netflixなどの大手テクノロジー企業には、カンファレンスで講演したり、トレーニングセッションを行ったり、自社製品に関する技術コンテンツを執筆したりするためのこれらの人々のチームがありますが、開発者の擁護者の役割は、ほとんどのスタートアップにとって適していません。なぜなら、彼らは迅速に行動する必要があり、残念ながら多くの開発者支持者は怠け者で平均以下の人だからです。

スタートアップ企業は、人々が毎日ではなくても毎週訪れたくなるプラットフォームとなるエンジニアリングブログを書いて構築できる、技術分野で高度なスキルを備えたエンジニアを必要としています。

スタートアップ企業は、テクニカルライティングとドキュメントをマーケティングツールとして活用する必要があります。

画像クレジット - 「開発者との関係の現状」 - ここから完全なレポートにアクセスできます。

効果的なコミュニケーションにおけるテクニカルライティングの役割

ソフトウェア開発者向けに、さまざまな種類の技術コンテンツを作成できます。

ドキュメントは重要ですが、マーケティングチャネルとしてドキュメントを活用しているスタートアップはほとんどありません。
チュートリアルとハウツーガイドは、エンドユーザーが実際の世界で製品を使用する方法を理解するのに役立ちます。
認知度を高めるコンテンツは、ファネルの上部を増やすことを目的として作成され、リーチを増やすために外部パートナーサイトに公開される場合があります。 Hashnode、DevTo、HackerNoon、DZone はすべて、開発者コンテンツを公開する無料の場所です。
Web サイトにブログ投稿を投稿すると、読者を惹きつけてサインアップを増やすことができます。
Web サイトやニュースレターで技術ブログを執筆する独立系ライターやシニアエンジニアのスポンサーになります。

テクニカルライティングが明確さと理解をどのように確保するか

常に実際のコードから始めて良い例を書いてください。これにより、公の場で執筆する際にクライアントや投資家との信頼が構築されます。

人前で文章を書くための私の戦術:

最近、私の Twitter DM で誰かが私に尋ねました – 「こんにちは、Ankur、私はあなたのブログの大ファンですが、質問があります。あなたは人前で文章を書くとき、どのように対処していますか?」インターネット上の人々は時々、とても嫌な人です。」

「コメントをオフにするか読まないでください」というアドバイスをよく聞きましたが、私は長年にわたり、たとえ時々であっても、自分の投稿や他の人の投稿に対する見知らぬ人からのインターネットコメントを読むことで、膨大な量の知識を獲得してきました。人々はバカだ。

常に本当の事実について話し、正直であること

私は主に事実について話します。スタートアップに関する事実や、ライターとしての私の経験に関する開発者擁護者のいずれかです。一般に、事実に関する人々のコメントはごく普通の傾向にあると思います。私の間違いに関する事実に関して私が受け取る否定的なコメントの主な種類。私は主に、あるトピックに関する自分の知識レベルを自覚し、何かわからないときは「よくわかりません…」と言うことで、この問題を回避しようとしています。

間違いを編集してリファクタリングする

私のブログ投稿では、私の知識の限界に達したことについて多くのことを書いているため、多くの間違いを犯します。人々が間違いを指摘した場合、私はブログ投稿を編集して修正します。通常、私はブログ投稿を Twitter または LinkedIn のタイムラインに投稿した後、数時間はコンピューターの近くにいて、間違いが発生したときにすぐに修正できるようにします。

技術知識のギャップを埋める: スタートアップ開発者関係プログラムにおける中心的な課題

調査レポートでは、2023 年にデベロッパーリレーションズ担当者にとってコンテンツ開発がトップの仕事活動であり、教育関連のコンテンツ開発 (55%) とドキュメントなどの技術コンテンツ開発 (50%) が区別されると述べています。これは、開発者コミュニティと関わり、教育する上でのテクニカルライティングとコンテンツ作成の重要性を強調しています。

すべてのスタートアップが技術ブログを始める前に尋ねるべきトップ 3 の質問

技術ブログを開始することは、意図された目的を効果的に果たすために思慮深いアプローチが必要であるため、スタートアップ企業にとって重要なステップとなる可能性があります。

スタートアップのために新しいブログを始める場合は、次の質問をしてください。

書く目的
対象者
作成するコンテンツの種類

ブランド認知度の向上、ドキュメントの補足、読者の構築、思想的リーダーシップの確立など、ブログの目的を特定することが重要です。次に、対象読者を理解し、絞り込むことは、それに応じてコンテンツを調整するのに役立ちます。最後に、チュートリアル、まとめ、ケーススタディ、特集、Q&A、比較、意見記事など、コンテンツの形式を決定することは、一貫性のある魅力的なブログを維持するのに役立ちます。

このブログはこれで終わりです。このトピックについては引き続き執筆し、次回のブログでより具体的な機能についてのさらなる洞察を共有する予定です。

楽しみにしていてください。それまで、読んでいただきたい私の最も人気のあるブログをいくつか紹介します。

今後の投稿でテクニカルライティングの力についてさらに詳しく共有することを楽しみにしています。