企業の技術文書については、確認の上位5つの間違い
私はそれを何度も見てきました。 1つ私はエンジニアリング会社では見たことが最も一般的な弱点の実際のところ、ほぼ普遍的な障害、適切な技術文書の不足している。一部では、このオフに笑うだろう マイナーなディテールが、その影響はしばしば深刻です。会社全体の将来行うことができますまたは失われた彼らは長年、私がした5つの問題を認識しているこのissue.Overに注意を払って量に基づいて 発見が特に技術的なドキュメントの作成に関しては共通する。私はあなたにこれらの考えを共有するには、下のと同じpaths.1落下などを防止するのを期待してしたいと思います。ていない任意のユーザを持つ manualsDon't笑う。これはかなり基本的なミスのように見えることがあります不条理も、それは驚くほど一般的です。私は彼らの製品、または、そのマニュアルのユーザーマニュアルを提供していない多くの企業が遭遇したものだ skeletallyまたは年間旧式の薄い。実際、私は推定したいこのカテゴリに小さなエンジニアリング会社、私は秋に出会ったの約半分。 （もちろん、1つのほとんどは、この問題は、購入を検出する オフには、市販のソフトウェアや家電製品。エンジニアの間でも、それは情けないほどよくある話です）私が覚えてどのように1つのエンジニア、なぜ自分の会社が自社製品のすべてのユーザーマニュアルを提供していないと言った。 〜で 静まり返ったトーンを、彼は"私たちのマニュアルを書き込むことによって任意のお金をしないことからだという。それはお金ではないのベンチャー行うため、当社の経営陣は、この上で時間を無駄にしたくない。"腹式に忍び込ん彼 に直面し、彼は近くを突いた"と言い、私たちまともなドキュメントを持っていない私達は多くの顧客を失っている。トークの愚かなペニーされて、賢明なポンド！"これは苦しむだけでは、顧客ではない場合 マニュアルは不十分である、または存在しない。何について、従業員は？どのようなときは、新しいエンジニアの基板上になると、発生するとすぐに学習している？または何時に、既存のエンジニアが理解する必要が起こる 自らの製品ラインの不慣れな面の詳細は？ユーザマニュアル、適切に書かれ、最大速度に持ってくる優しさと効率的な方法を提供することができます。それがなければ、彼らに依存せざるを得なくなる より強く、他のエンジニアになるため、全員の関係者の時間を無駄に教育する。貴重な人材の週、いない場合はヶ月、このfashion.2で無駄にすることができます。持ち合わせていないと、適切な内部documentationItの だけでなく、ユーザーマニュアルは、企業に及ばない。の企業が、製品のリリースを急ぐの内部文書を頻繁に犠牲者としても、です。その急いで製品を市場にもたらすため、企業 多くの場合、内部の設計書類は絶望的wayside.Itによって落下させることは、プログラマーやエンジニアが精彩を欠いたコミュニケーション能力を持つことで悪名高いが、助けていない、ドキュメント、タスクされている 彼らはめったにお楽しみください。私は多くのソフトウェア企業が遭遇したことが、そのソフトウェアの設計難治性の混乱アーキテクチャーの文書は、インターフェイスの説明との不足のためにされた例では、のためのコードのコメントです。 悲しいことに、私は同様の問題を見たときに、機械的なデザインになると、電子回路設計、製造の手順？またはit.I'VEのその企業のいずれかの下で行っているエンジニアに話さ名ぐらついている 危機にひんしている。ほぼ例外なく、十分なドキュメントの欠如、"私は私の仕事とびきりのも記載されていることを確認するなどsituations.Iは常に私の上司や同僚の指示の主要な要因となっている。もし私が もし私が交通事故で死ぬか、会社を残し、わたしは、この会社で私がいなくて行進することを確認したい。"それは1つの完全なドキュメントを維持、確認するための背後にある主要な理由である必要があります は、同社が空転する可能性はありませんがabsence.Unfortunately、多くの従業員が反対の方針を採るすべての人。彼らは意図的にマニュアルで、それにより、一部のジョブのセキュリティを確保すると考えてけちけちする 時には、この作品。ただし、スマートな雇用主は、エンジニアの人の文書もこれまで彼のベストに近い自分のカードを保持、別のエンジニア以上の価値を知っている。後者は、短期的には、必要不可欠である可能性があります しかし結局、彼は長期的なliability.3だ。忘れて1つのaudienceThis問題は多くの場合、ユーザーマニュアルの開発が発生します。プログラマーやエンジニアが頻繁にそのマニュアルを読むことになることを忘れ 彼らの製品、または人は、同じ技術的なスキルを持っていないに慣れていない人。私は特定の1つの企業の西海岸にあるマシンコントローラ同社は覚えている。彼らの"ユーザーマニュアル"をされた 恐ろしいごちゃごちゃ-頭字語のずんぐりした人、未定義の用語、一見ランダムな思考、約1ダースの手順は、特定の順序に記載されています。自分のユーザーマニュアルをどのように開始するなどの基本的な詳細に欠け コントローラを設定、またはどのように緊急事態の場合にはそれを停止し、任意の新米ユーザmanual.Aに関連する問題で検索することを期待すべき重要な詳細は、障害が適切な言語を使用しています。の場合を考えてみます 読者の多くは英語を母国語のネイティブされないとき、または、ヨーロッパやアジアでの製品マーケティング、外国出身の工場労働者の組み立て手順を書くと言う。このような例では、それを維持する必要があります 言語はかなり簡単です。この場合不可、と言うとき、その精度の需要が大きな1つはしばしばいくつかの適切に、選択したグラフ、図や写真を追加することによって補正することができます複雑な詳細を議論する。どちらか一方の アプローチは、複雑なテキストのことで、少しabsorb.4簡単に役立つことができます。探して適切なgraphicIt紛れもなく、 ©、clichÃÆ'Ãだが、真のそれにもかかわらず、百聞は一見にペイントはありません。同様に、 は、画像や図をはるかに理解するよりも1つは、完全にテキストdescriptions.Someで構成され、この検討幼稚なことに、不要な簡単になるの賢明な利用して手動で。私はしない、と私 経験では、ユーザーの大半は、これらの視覚的なガイドが理解を示している。忘れないでくださいどんなに読者が、それでも人間だ洗練された。ても、そうでない場合は注意してインテリジェントなリーダーをすることができます 誤って、特にtime.5に追われるいくつかの重要な詳細を欠場。探しexcellenceItはどのようにプログラマーやエンジニアが卓越して自分の仕事は、まだ多くの面で努力することができます参照して興味深いのために努力 全く逆のアプローチを取るときに、ドキュメントにしています。 "誰の文言なんて関係ないよ？"私は多くのエンジニアがいると聞きました。 "ここでは詩や脚本を書いていないけど、どういう事項をされている マニュアル、技術的に正確である必要があります。"これは呆れるほど、目先を表示します。技術の精度確かに重要ですが、そのプレゼンテーションのスタイルです。少数のエンジニアは、求職者に耳を傾けることは バスローブ、スリッパ、又は谷の少女のように話すの訴訟の弁護士と、まだ何とか、これらの同じエンジニアたちは仲間の技術者（または、お客様の悪化！期待に）蛇行のページを強打し、開くを示しています 不完全に言えばテキストです。でさえ基本的なスペルチェック、文法や校正の問題はしばしば、単なる厄介な問題として扱われることは何も一瞥以上の価値があります。詳細はくだらない（私の救済するために、私はしていない 雇用の私の場所でそのような態度が発生しました。私はこれと言って急いで、誰でも傷は、私とは、働く人々についての不満だと思う！いいえ、私はすべての卓越性の価値を認め、見つけた これはいつも感謝しています。しかし、私は話を戻そう。）注意：1つの仲間の技術者の書面を、1つを負わなければならない心の中で彼らは、しばしば時間のわずかな量で多量の情報を吸収する必要があります。いつ 素人の書面を、1つのテキストをしなければならない、穏やかで、できるだけ消化しやすい、傷がgeekspeakの海で迷子になる。いずれにせよ、優雅さとスタイルのある事項には少し余分な労力を費やすことができます difference.Iの世界をどのようにこのテキストの範囲を超えていると良い記述テクニック、構成について詳細に移動されませんを確認します。十分には、優秀なプログラマーやエンジニアを確認すべきだとするために 彼の文章をよく読むことが組織化された、とそれをスムーズに1つのトピックanother.Iからの流れの信念を超えて興奮してくれれば私は別のずさんな場合、または私は別の話を聞いたことマニュアルを見たことがない 企業が存在しないドキュメントのために崩壊。絶望的なファンタジー？多分。それでも、私はいくつかの技術者が、このメッセージを読むだろうし、期待して彼らはそれAuthorV heart.Aboutに連れて行くでしょう。 Berbaベラスコ 電気工学の博士号を取得して、ほぼ10年間、彼の貿易を撚るされている。その間に、彼は、繰り返し、そこから発生することが落とし穴なテクニカルライティングの重要性を発見した そのvalue.Dr無視されます。ベラスコ、現在として働いてシニアと携帯テクノロジー株式会社（http://www.immunospot.com用のソフトウェアエンジニア電気http://www.elispot-analyzers.de）、クリーブランドでのバイオテクノロジー企業、
記事のソース: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
ウェブマスター向けのHTMLコードを取得
この記事を追加してお客様のウェブサイトを今しなさい！
ウェブマスター向けの記事を送信してください
登録の必要なし！フォームに記入してください Messaggiamo.Com 記事は、ディレクトリ！
