テクニカルライティングのアドバイス

このガイドは、特にウェブテクノロジーとブログに関するテクニカルライティングに関するアドバイスと洞察をまとめ、経験豊富な専門家や個人的な経験から描きます。

あなたのトピックの選択：

理想的なトピックは、あなたが情熱を持ち、個人的に投資しているものです。あなたの熱意は輝きます。 Chris Coyierが賢明にアドバイスしているように、「何かをグーグルで検索したときに見つけたい記事を書いてください。」割り当てベースのライティングは生産的ですが、個人的な接続は品質を高めます。

知識が新鮮である間に書く：

書くのに最適な時期は、何か新しいことを学んだ直後です。経験はまだ鮮明であり、理解の「前」と「後」を伝えることができます。学習プロセスについてクイックメモを書き留めることでさえ、後で価値があります。マヌエル・マツゾビッチが例示しているように、「今日私が学んだ」（TIL）アプローチを考えてみましょう。

レバレッジ比較：

強力で活用されていない技術は、新しいテクニックを馴染みのあるテクノロジーと比較することです。レイチェル・アンドリューは、jQueryに精通している人に現代のJavaScriptテクニックを説明し、新しいものと既知のものの間のギャップを埋めることを提案します。このアプローチは、馴染みのない基盤を馴染みのない基盤に結び付けます。

魅力的な紹介の作成：

一般的な落とし穴は、記事の目的を明確に述べ、ターゲットオーディエンスを早期に明確に述べていないことです。レイチェル・アンドリューは、主題と意図した読者をすぐに明確にする簡潔な紹介の重要性を強調しています。ブライアン・リナルディは、よく書かれた入門段落が読者が継続するかどうかを判断できると付け加えています。

クリアで簡潔なタイトル：

Erin Kissaneは、Clickbaitよりも明確な明確なタイトルを優先する明確で説明的なタイトルを提唱しています。 「GlageQL、Phoenix、およびReactの開始」などの明確なタイトルは、あいまいなClickBaityのものよりもはるかに優れています。明確さは、読者の理解とSEOの両方に利益をもたらします。

アウトロの芸術：

Ben Halpernは、結論の段落の重要性を強調しています。簡単な要約（「あなたが言ったことを「em」と伝えます」）は効果的ですが、巧妙に作られた結論はメッセージを補強し、閉鎖を提供します。

スキャン可能性の向上：

ブライアン・リナルディは、読みやすさを向上させるために大きなテキストブロックを分割することの重要性を強調しています。テクニックには、サブヘディング、リスト、関連する画像とスクリーンショットの使用、例示的なグラフィック、簡潔なビデオ、順調なコードブロック、テーブル、および折りたたみ式セクションを使用します<details>/<summary></summary></details> 。間隔、色、アライメントなどの設計要素の戦略的使用は、スキャン可能性をさらに向上させます。

アクティブな音声と単語の選択：

Katy DecorahとNeal Whitmanは、パッシブ音声（「リクエストはサーバーによって処理される」）ではなく、Active Voice（「サーバーがリクエストを処理する」）を使用することの重要性を強調しています。 「Just」のような言葉は避けてください。

トーンと声の維持：

トーン（あなたが何かを言う方法）は、コンテキストと一致する必要があります。フレンドリーで、権威ある、歓迎的で、感謝の気持ちのトーンは、一般的にテクニカルライティングに適しています。さまざまな状況のトーンを調整しても、音声（あなたの性格）は一貫性を保つ必要があります。

長さの管理：

テクニカルライティングはしばしば過度の長さに苦しんでいます。ウェイド・クリステンセンは、冷酷な編集アプローチを推奨しています。過度に短い投稿も問題がありますが、単語数ではなく、明快さと有用性が主要な焦点である必要があります。長い投稿をシリーズに分割することは、部品がテーマ的に異なり、自己完結型である場合にのみ行う必要があります。

作家のブロックを克服する：

恐怖と自己疑念は、技術的なブログに対する一般的な障壁です。マックスベックは、「準備ができていない」声を無視して、本質的なポイントがカバーされたらすぐに出版を提案します。ジェレミー・キースは、ドラフトを維持することに反対することを助言します。小さな貢献でさえも役立つことがあります（Matthias ott）。アリ・スピッテルは、初心者でさえ貴重な視点を持っていると指摘しています。

スタイルと創造性：

Sara Soueidanは、完璧なライティングスタイルは1つもないことを強調しています。あなた自身になり、明確さを維持しながらあなたの性格を輝かせましょう。注釈付きの会話やビデオシリーズなど、創造的な形式を試してください。

初心者中心のコンテンツ：

Webには初心者レベルのコンテンツが詰まっていますが、よく書かれた入門書が際立っています。明快さは、すべてのスキルレベルにとって価値があります。

現実世界の例と抽象化：

クリスティーンは、複雑な概念を説明するための現実世界の例の重要性を強調しています。ただし、明確さを妥協する例は避けてください。抽象化は、効果的に使用すると強力になります。

ブログの利点：

ブログは、キャリアの見通しを強化し、専門知識を示し、理解を向上させます。 Khoi Vinhは、ブログを「アンプ」と説明しています。

練習と改善：

一貫した執筆と公開は改善のために重要です。 「ステークスで書く」（作品を公に共有する）が最も効果的な学習方法です。

あなたの声を見つける：

あなたの知識を共有することから始めます。個人的な経験を取り入れ、他の人を引用し、研究を実施することにより、執筆を強化します。

ゲストの投稿：

サイトにピッチングする場合は、ガイドラインを注意深く確認してください。

便利なツール：

コラボレーションのためのドロップボックスペーパーと校正のための文法は、推奨されるツールです。

以上がテクニカルライティングのアドバイスの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。