多くの人々は、良いテクニカルライターになるためには、トピックの専門家でなければなりませんと信じていますが、これは一般的な誤解ですが、人々がこの信念を持っていることは驚きではありません。 結局のところ、テクニカルライターとしてのあなたの仕事は、簡単に消化できる方法で複雑で技術的な情報を聴衆に伝えることです。 もちろん、人々はあなたがトピックのトピックに深く精通していることを期待します。 幸いなことに、現実はあなたが世界クラスの技術的な記事を書くために中小企業である必要はありません。 必要性とは、好奇心、構造、そして問題の専門家に正しい質問を求める意欲であり、それは技術的な書くことの美しさです:正しい質問をすることは、すべての答えを持つことよりも重要です。 ドー グレート・テクニカル・ストーリーへの非SMEガイド Branding Your Lack of Expertise Like the Weapon It Is あなたの専門知識の欠如を武器のようにブランディッシュする 素晴らしい技術的な書き方は、学習者の考え方から始まります. あなたがとても心配している専門知識の欠如は、あなたに興味深い利点を与えます。 そして あなたは専門家が尋ねるのを忘れていた質問(読者も静かに尋ねている質問)、あらゆる概念に質問し、ジャーゴンを単語に分解し、自分の知識のギャップを埋めることで、読者に最高の経験を与えます。 greenness curiosity https://ucatt.arizona.edu/news/curse-knowledge?embedable=true 2. トピックの専門家との関係構築 私たちは、あなたが素晴らしい技術的なストーリーを書くために中小企業である必要はないことを確立しましたが、 あなたはその人(またはリソース)との関係を構築する必要があります。あなたはあなたが書いているテクニカルプロジェクト / トピックの背後にある脳との接続が必要です。 someone あなたの仕事は、その人の洞察と読者の間の橋になることです。 しかし、ここに中小企業の問題点があります:彼らはしばしば独自のシステムの複雑さの中に深く生きています。あなたはその洞察を引き出し、それを旅行するものに翻訳するためにそこにいます。 あなたが正確に彼らの仕事を表し、慎重な質問をし、彼らの時間を尊重して扱うことを信頼します。 build trust. SMEとのコミュニケーション方法 
 
 
 
 
 まず自分の宿題をしなさい. SME 会議に出席しないでください. 読んで、研究し、具体的で知的な質問で準備してください。 「何」はあなたに何が作られたかを語り、「なぜ」はあなたにそれが誰のためにあるのか、そしてなぜ重要なのかを語ります。 直ちに用語を明確にしてください. 誤解しないでください. 技術的な部分の誤った用語は信頼性を損なうことができます。 各通話後に概要をまとめ、理解したものを短くフォローアップし、同じページにいることを確認してください。 第3話 翻訳しないで あなたがペンを紙に置く準備ができたら、あなたの仕事は、専門家のジャーゴンをページに捨てることではないことを覚えておかなければなりません。 実際には、これはジャーゴンを単語に切り落とすことを意味します。 読者は、それを動かすすべての興味深いテクノロジーではなく、製品/サービスによって影響を受けます。 どう と言うよりは、 と言って、 「製品XYZは、最先端の、最初の種類のblah blahで作られたため、素晴らしいです。 「最先端のblah blahで構築された製品XYZは、あなたがABCを行うのを助けるために素晴らしいです。 違いを見る? 最初の行はテクノロジーを平らげ、2番目の行は読者に奉仕します。 結局のところ、あなたは専門知識と日常の理解の間の橋を築いています 橋が明確になるほど、より多くの人々が橋を渡ることができます。 4. Fact-Check Like Your Life Depends On It (Fact-Check Like Your Life Depends On It) これはオプションではありません、特に非中小企業の場合です。 技術的なストーリーは正確性に依存します。 プロザとは異なり、あなたの事実は100%真実で検証可能でなければなりません、あなたのコードは機能しなくてはなりません、あなたの例は再現可能でなければなりません。 すべて - スクリーンショット、コードのショット、および統計 - 確認のためにあなたの専門家に戻ります。 あなたは信頼のゲームをプレイしています。 Tell the Story (Keyword「ストーリー」) 事実を確認したら、ストーリーを構築しましょう。 結局のところ、テクニカルな書き込みは . 書く And that means it needs structure, flow, and payoff. Anchor your piece in a (問題または目標) を展開する (あなたのプロセスまたは発見)、そして近くに (視点や行動) why how what next 物事を容易にするために、私たちはこの正確な3つの行為構造に基づいて実践的なガイドを作成しました。 
 
 ここから始める:テクニカルストーリーライティングテンプレート。 Get started with it here:  . Technical Storytelling Writing Template Technical Storytelling Writing Template(テクニカルストーリーライティングテンプレート) 最後に、良い質問をしなさい、友人に説明しているかのように書きなさい、そしてどこから始めるべきかを忘れたら、明確さが複雑さを打ち負かすということを覚えておいてください。 私たちは、これがあなたにテクニカル・ライティング業界をトピックの専門知識なしでナビゲーションすることについてのいくつかの明確さ(そしてあなたの懸念を安定させた)を提供したことを願っています。 次回まで!

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

EditingProtocol.com

このオーディオは、ストーリーの元の言語で制作されています。

You Don't Have to Be a Subject Matter Expert to Excel at Technical Writing(テクニカル・ライティング)

About Author

コメント

ラベル

この記事は

Related Stories

クラウド移行を成功させるための完全ガイド: 戦略とベストプラクティス

ユーザー中心の暗号通貨製品の作成: 顧客からのフィードバックの重要性

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

クラウド移行を成功させるための完全ガイド: 戦略とベストプラクティス

ユーザー中心の暗号通貨製品の作成: 顧客からのフィードバックの重要性

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps