English version
German version
Spanish version
French version
Italian version
Portuguese / Brazilian version
Dutch version
Greek version
Russian version
Japanese version
Korean version
Simplified Chinese version
Traditional Chinese version
Hindi version
Czech version
Slovak version
Bulgarian version
 

技術の書面を恐れる

執筆のヒント RSS Feed





IntroductionSometimesそれは企業や個人の予算を超えて、技術文書のアドレスにはプロの作家を採用することがあります。すべての技術文書を生成する必要があります理想の世界では 高度に訓練された専門家が、残念ながら我々は理想に住んでいない。同じように多くの人が自分の家電製品を修復するために、多くの人々の技術文書の品質を記述しようと試みますがします。 トースターをいじると同様に、電気ショックで、最終的には失敗になります前のアドバイスを受けずに、ゼロからの技術文書を書き込もうとすることがあります。親指の大まかなルールとして、常に模索する必要があります しかし、専門家を採用する場合とは言えないし、不幸な貧困層が持っていたがドキュメント職務それらに押し付けている、絶望して行うことができますどんな理由がある。この簡単なガイドをいくつかのコアスキルが必要になります。アウトライン あなたの文章、技術的な規則を促すために必要な場合、考慮することができるソフトウェアパッケージを避けるために明確なものを認識する。うまくいけば、たとえ何かについてのあなたの生活の中で文を書かれたことがない あいまいにするには、少なくともあるが、技術的、何のテクニカルライティングentails.Whatの広範な画像を書く?技術は当然十分に書き込むことによって技術的な記述を参照する技術です。 〜だけれども これは、虚偽の定義のように、それを覚えて重要なのかもしれません。あまりにも多くの技術者は、いずれも、技術的またはすぎる'はドキュメントの作成のミスを犯す'文学。技術的な良い 著者は、2つのドキュメントをエンドユーザーに合うようにとの間のバランスを調整することができる必要があります。テクニカルライティング、新鮮な空気、パーベイシブ、まだほとんど目に見えないようにたくさんある。奇妙な有線の世界では は、我々は、技術文書の作成自分自身を見つけるいたるところにある。ソフトウェアマニュアルは、家電製品、教育用チラシを、電子メール、手紙のユーザーガイド、レポート、技術的な報道では、統計情報や経歴に テレビのスポーツのすべての人々に日常的にさらされている技術文書の例を示しています。場合は、これまで家庭用ビデオレコーダーの時間設定をプログラムして、全体のマニュアル遠隔地試みた うんざりして部屋の場合、(ただし、明らかではない、非常に良い1!)が多すぎます回技術文献の技術、またはではない十分な大きさを把握するとライターによって生成される技術文書の一部を投げた 技術者が不足する能力を記述する。として、将来の技術者が技術的に専門分野(sの知識が豊富であることは非常に繊細なライン)だけでなく、踏む必要があります'良い家(とされて 普段甘い歳の女性、または何かを襲うことができる悪い'作家')に反対した。テクニカルドキュメント通常2つの別個のユーザグループ、すなわち、専門家レベルのユーザーは、単純なユーザーに対して生成されます。として あなたの最初のタスクの技術者1あなたのため、これを巧みに私をもたらす書いているか観客を整理することです:知ってなた、 ©、誰もが評論家の行く古いclichÃÆ'à foeAs。これは特に当てはまります ほとんどのまともな人々の反応のときに、テクニカルライティングに直面する。上記のビデオレコーダーの例で強調表示され、技術的な記述をエンドユーザーに不可解なことができます。このような場合です、そうですので、 誰でも、彼らの視聴者を識別し、自分のレベルへの書き込みを気にしていないドキュメントを書いている。このように明白なポイントだが、1つは、しばしば見過ごされている、あなたの作成されている文書のユーザーは、 実際に専門家されない場合があります。明らかにする場合は、特定の先進的なユーザグループに対して特定の専門製品のドキュメントを作成している(良い例では、コンピュータシステムのためのソフトウェア監査される可能性が 管理者)の場合、この構成する必要が完全に別の方法である場合、例えば、作成しているよりも、マスマーケット向けのコンピュータソフトウェアは、未経験のホームユーザーを目的とした技術マニュアル。のいずれか あなたの前にも、紙にペンを入れ、指のキーボードには、最初のタスクを実行する必要がありますドキュメントのユーザーが誰かを特定すると構築する文書は、特定のターゲットグループ(複数可)を目指している。もし この段階では、あなたの文書を避ける必要が正しい迷惑の部屋!企画、作成される文書には、ターゲット市場を識別してperfectionOnceの間でスローされ、必要となる取得 どのようにドキュメントを開催される計画を開始する。このプロセスは、主にドキュメントが生産されている依存していますが、親指のいくつかの大まかなルールに従うことができます。場合、文書はまず、サポートするために 特に、製品の詳細は、コンピュータのアプリケーション(など)それをできるだけ早くすることができますあなたの汚れた手に入れる。詳細はあなたの攻撃計画を策定することができる構成を開始する製品を調べることにより 組織構造体。場合に努めていますがなくなりを詳細には、初期の探索段階でこれを行うと多量のメモを取る場合は、絶対に不可欠であることが時間を節約することができる製品を模索している 締め切り。そこのレイアウトに一貫性がないことを確認する必要があります計画段階でも、そして組織的な構造は、文書の時。選択して番号規則、段落スタイル、および生成レイアウトの大まかなアイデア 目的は現在、重要な時間later.Let各セクションの最初に、ドキュメントが草案の作成に、下書きinBeforeダイビング真っ逆さまに保存します。場合は、書類を持っていないが作成され、この順序を変更できるようになります 真剣に、プロジェクトに影響を与えることなく、'論理的な流れ'。多くの技術ドキュメントを、より詳細な製品(特に)多くの(そして実際に数え切れないほどの場合もあります)の繰り返しで構成されます。これは、 これは、製品にシフトし、時間の経過とともに変化し、1つの技術的な著者の主要な任務のこれらの変化に遅れないようにすることであり、それらすべてが順調に記載されて確認します。良い技術者が 人間的に、それぞれの案を見直し、できるだけ多くの下書きとして、までは位置whereby彼ら(とその雇用者)は、ドキュメントについては、正確かつタイムリーであるが満たされるまでは、常にを通じて文書をプッシュ 製品やその悪魔documents.Theプロセスの真の反射既に確認されdetailAsでは、技術文書の作成は、これは自然の中で技術的に呼び出されます。正確には技術的な中の一部です 高精度と一環として、人間的に可能な限り詳細にすることです。場合であっても作成されている文書と技術的洗練された高度なユーザーグループには、あなたのドキュメントの内容に焦点を当てる必要があります プロセス、または製品を使用しています。これを達成するのが難しいの偉業ことができますがいない場合は、あなたの聴衆に書き込む。決しては、読者が、文書化されるが、場合には、製品やプロセスについて何を知っていると仮定 先進的な/専門家のユーザーは、少なくとも事実は、おそらくどのように日常的に動作する装置を使用するように指示する必要はありません認識することが一般的な感覚があります。いつどのように実施する記述 この作成されているドキュメントの種類の規則に適合アクティビティまたはタスクは、各段階(数に関係を識別する)と、特定の何を書かれているテストが自分自身、または偶数の精度を確保する 良いことに、エンドとしては、同じスキルレベルのボランティア活動へのロープを、技術文書の羊皮紙と血を使用して作成することが可能ですjobAlthoughのための適切なツールをuser.Choose、賢明ではない。多くの専門家 ソフトウェアアプリケーションの場合は、強力なマニュアルを作成し、技術者としてのあなたの任務の一部を助けるために存在しているジョブのための適切なツールを選択しています。主に、この文書の性質に依存する 、およびそれらの最終的な分布の性質を製作されて。場合の文書は、インターネットを使って配信されるが、これは確かに考慮する道である。そのため、Flash MXとのようなパッケージを使用するために Dreamweaverでは、この目標を達成するために。統合されたオンラインヘルプの場合は、生のHTML文書、または交互にRoboHelpのまたは類似のような専門家パッケージを選択し、作成したい場合があります。印刷の場合は、ベースのドキュメント のソフトウェアパッケージに十分な場合it.Many経験の浅い技術者で即座にMicrosoft Wordの方向に回して何がスローされますを処理するための強力な選択する(それ5月の商業とユビキタスが必要になります 個人的な環境)。あなたのドキュメント150ページの下に起こっている限り、あなたの作成方法を知っているテンプレートとマクロで、MS Wordを避けるように。として任意の技術的な著者は意地の悪い習慣をしたことを伝えますすべてのそれは 自分は、頻繁に動作するように不安定にパッケージすることができます。場合は重いマニュアルグラフィックス作成している場合、クオークXpressのか、フィールドには潜在的に業界のリーダーを選択を検討することで、Adobe FrameMaker。 選択どのようなソフトウェアは、あなたが信じられないそれに習熟する、のいずれかの訓練では、投資、または1日に使用して一日の後に一日を確保する必要があります!通信-は、何をするかが支払われるの!多くの人々 を作成する技術文書を退屈され、繰り返し教えてくれます。これらの人々 、そしておそらく低能も間違っている。は、技術ドキュメント'を作成するプロセスを見つけることが退屈な'(もしあなたが 場合は、間違って仕事をしている!)とされていません。高品質の技術文書を作成する人々に十分にできるように重要な段階であり、正しく技術を使用します。これは、ユーザーがで作成したドキュメントに接近する 同じように彼らは斬新なアプローチは、最終的にそれらをどのように技術を使って実現したい達成を助けることができます。どんなに'プロセスのように見えるかもしれませんが、ユーザーが自分の目標を達成することができます鈍い あなたのドキュメントを読んであなたの誇りと確かに、幸福のラッシュを与える必要があります。限り、あなたの技術のときに、通信できるように文書を作成する人々の生活上に持つことができる肯定的な効果を覚えて より効果的に、皆さんのコミュニケーションプロセスで幸せになります。ドキュメントのライフサイクル全体を通して、多くの場合は(該当する場合)可能な限りの同僚と連絡を取るに努める必要があります。それらを読んでみましょうあなた 文書を、彼らの批判に耳を傾け、あなたの文書を調整する(もし、皆さんと主張することはできません!)技術者の通信には、どうしてあなたと通信しており、決して忘れないとしないことを確認支払われているため 人は、ドキュメント内のthemselves.Common間違いmakingWhen、技術的な文書の作成を回避することができる致命的な欠陥がいくつかあります。ではない完全な意味は、このセクションの詳細は以上の 一般的なミスの新しい作家、期待して、それらも:Patronising存在-技術ドキュメントをクリアする必要がありますこれを避けることにし、それpatronisingてはいけません。現在のドキュメントを作成していない 低能が消費者とクライアントによって読み取られる。あなたはいつも観客のスキルレベルには書かなければならない技術的なレベルの人々が何であるかに関係なく、彼らは低能ではありません。も、子供たちが気分を害する patronised人の給料、子供、ユーモアのotherwise.Overuseを払っている人とは、ミスをしない-人々を楽しまれるための技術文書を読んでいない、彼らは成功したのを期待して読む には、プロセスを完了するかの情報を抽出します。しない限り、エンドユーザーには、ユーモア、可能な限り避けるために関連します。場合、本は、罰金と良い書いている。場合は、マニュアルのようなユーモアを避けるため書いている ペストとして、より多くのユーザーはより冗談を欠場することだけでは-でさえ、草案作りの段階ではdocumentation.Inconsistency書き込みpatronisingばか嫌悪感を最後にすることを確認する必要がありますが、すべての要素 あなたの文書で使用される一貫している。これは、それをレイアウトとしては、文書の'音'にも適用されます。ことを確認し(最初の人など)だけでなく、ページのレイアウト、改ページの要素を、一貫性の感覚を使用する ヘッダーとフッター、および他のすべてのテキストelements.Proofを読む-技術文書の一部を作成するの終わりまでには、おそらくそれの姿にうんざりされます。それは問題ではありません。どのような事項は何の葉です あなたのオフィスや家庭、正確です。そのために証明するにはすべてを下書きし、の前に、証明書に分散され、再度、もう一度、もう一度それを読むまでは、ドキュメントをご覧ください。決してスペルチェッカー(彼らは決して作業)に依存 の場合は、それを避けることができるだけご自身の判断に頼ることはない。可能な限り配布する前には目を、多くのペアは、すべての後、彼らはあなたが欠けている一つの場所があなたのドキュメントを取得読み取る 作成process.Conclusionを通して/恥知らずの自己promotionTechnical書面に関係なく、簡単な仕事かと思うかもしれませんではありません。これは専門性、忍耐力と能力の非常に奇妙な混合物が必要です。同じように 他の仕事を、どのようにそれをするが、学ぶことができますも、その授業は必ずしも何かそれで良いことはありません。まだ、創造的な焦点はまだコミュニケーション、および柔軟性の肛門にはよい技術者にするには、お持ち 専門家。これは、おそらく想像することができますが、単純な作業です。ただし、あなたの技術文書を作成すると思うかもしれないが、正確に作成し、一貫性のある簡単ですし、タイムリーに高い商業標準のためのドキュメントです 非常にやりがいの役割。関係なく、お客様の予算で、長い場合は、専門家を雇うに重要な投資収益率を提供する実行します。結局のところ、彼らは日で、私たちのしようとしてあなたの髪を何涙を行うことができる 場合(パブリケーションの登録、Namesfacesplaces、セキュリティフォーカスなどとして働いてマイクケンプフリーランスのITジャーナリストの年間雇用されているAuthorOver months.About週間ではなく数で達成 Packetstorm)、コピーライター、ビデオゲームのデザイナーは、セキュリティ監査、Webデザイナー、グラフィックデザイナーやITトレーナー。彼はフリーランスの両方を小さく(男性2人と犬などのための恒久的な位置の様に)働いている 両方は、英国およびヨーロッパの各地の多国籍組織する企業。する様々な記事、書籍、マニュアル、およびその他さまざまなコピーを、クライアントのために働いて、マイクは通常の様々な汗を流し発見することができます 未発表の小説。彼は、彼の短編映画の脚本の独立した生産企業による生産のいくつかあったし、現在いくつかの機能の長さscripts.Mikeに取り組んでいる主に喜んでものすごくに住んでいる

記事のソース: Messaggiamo.Com

Translation by Google Translator





Related:

» Credit Secrets Bible
» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula


ウェブマスター向けのHTMLコードを取得
この記事を追加してお客様のウェブサイトを今しなさい!

ウェブマスター向けの記事を送信してください
登録の必要なし!フォームに記入してください Messaggiamo.Com 記事は、ディレクトリ!

Add to Google RSS Feed See our mobile site See our desktop site Follow us on Twitter!

記事を送信してください Messaggiamo.Com ディレクトリ

カテゴリ


著作権 2006-2011 Messaggiamo.Com - サイトマップ - Privacy - ウェブマスターの記事を送信してください Messaggiamo.Com ディレクトリ [0.01]
Hosting by webhosting24.com
Dedicated servers sponsored by server24.eu