ドキュメントの読み方
2191 ワード
あなたがすぐにドキュメンテーションで答えることができるという質問をするならば、人々の反応はあなたが尋ねる場所の雰囲気、あなたが働くチームまたはオンラインフォーラムに依存します.フレンドリーなものをどこにあなたの答えを見つけることができるリンクを与える.以下のフレンドリーなものは“RTFM”を提供します-咳フレンドリーマニュアルを読む-またはあなたに私にあなたのためにあなたにそれをするためのリンクを与える.
それを避けるようにしなさい.
どのようにドキュメントを読むのスキルを開発することができます見てみましょう!
─
最も重要なことは、ちょうどあなたが物事と闘うようにドキュメントからの回答を取得しようとし始める.ドキュメントを読むことの最も重要な利点は、あなたがしばしばそこであなたの答えを見つけるということです.あなたはそれに飛び込むと自分でそれを見つける必要があります.あなたのキャリアの進捗状況として、あなたはより多くの問題を見つけることが、チュートリアルに従う準備が整いました.
─
ほとんどのドキュメントは比較的乾燥しており、答えを提供することを意図しています.問題の解決策を探している間、それに集中するのは、より簡単です.
私は、プロジェクトについて学ぶためにドキュメンテーションを読んで嫌いです.私が始めている新しいプロジェクトまたは私が学んでいる図書館であるならば、それは重要でありません.私には文脈がないので、それは時間の浪費のように感じます、そして、私が読んでいるものの間の接続を理解するのは難しいです.
その代わりに、私は自分自身で何かをして、失敗して、答えを探すドキュメンテーションに戻ってきます.その場合、私は少なくとも私が知らないものを知っています.
─
─
すぐに関連する情報を修正するときに修正する必要がある検索ツールを使用することができます.
サードパーティのライブラリの場合は、検索エンジンを利用して、プロジェクトのウェブサイトへの検索を制限することができます.
─
これは、Google、ビング、およびDuckduckgoを使用して同じ動作します.
コードドキュメントでは、コードベースを検索するために使用するのと同じツールを使用できます.
エディタ検索において
─慶喜3年(1666年)7月17日
─慶喜3年
唐辛子
- 1 , 566 , 914
─
docを検索するにはいくつかの利点があります.
あなたは、文書構造
あなたのトピックに関連するドキュメントのすべての部分を見つけるでしょう
─
APIリファレンス-ドライメソッドの説明
─
チュートリアルやガイドより多くのコンテキストを提供します.
─
ドキュメントの品質は大いに異なります.多くの場合、それは非常にアクセス可能なドキュメントではありません.読者がシステム知識を持っているという仮定があり、テキストには明示的に記述されていない.これは、新参者が少し失われる葉.
最も問題があるのは、クローズドソース、商用プロジェクトです.あなたがCodeBaseとそのドキュメンテーションの両方を維持している小さなチームを持っているならば、それはドキュメントを通って行って、それを理解しようとするどんな新しいセットの間でも月でありえます.
オープンソースプロジェクトは、通常、わずかにより良いです.良いドキュメンテーションのないものは、成功する可能性が低いです.
─
プロジェクトがチュートリアルまたはガイドを提供するなら、それをチェックするのは良い考えでありえます.よく似た問題を抱えて闘っているなら
それをカバーし、それを通過ガイドの一部をして下さい.よくやったガイドでは、完全に使用しているメカニズムを理解するために必要なコンテキストを提供します.
─
─
APIの説明は、最も技術的なドキュメントです.通常、それはかなり乾いていて、与えられたメソッドを使用することができる文脈の良い概要を欠いています.それはあなたのすべてのクラス、メソッド、引数を示し、あなたの処分で持っている出力.
─
利用可能な場合は、同じまたは同様のものの別の説明を通過します.多くの場合、他のリファレンスを参照することが多いので、最初に読んだ後にまだ失われている場合は、他のドキュメントがクリアされているかどうかを確認できます.
─
メソッドを使用すると、オブジェクトの内部状態を変更したり、出力を取得したりします.APIガイドは両方ともかなりよく説明するべきです.
─
多くの場合、メソッドは引数の多くの組み合わせで入力を受け入れます.ドキュメントでは、必要なすべてのものを得るためのすべてのオプションが表示されます.
─
ドキュメントを読むことは重要なスキルであり、練習によってのみ学ぶことができます.あなたの最初の試みとの闘争として落胆しないでくださいそれは時間とともに良くなる.
─
を読んでください.
それを避けるようにしなさい.
どのようにドキュメントを読むのスキルを開発することができます見てみましょう!
─
最も重要なことは、ちょうどあなたが物事と闘うようにドキュメントからの回答を取得しようとし始める.ドキュメントを読むことの最も重要な利点は、あなたがしばしばそこであなたの答えを見つけるということです.あなたはそれに飛び込むと自分でそれを見つける必要があります.あなたのキャリアの進捗状況として、あなたはより多くの問題を見つけることが、チュートリアルに従う準備が整いました.
─
ほとんどのドキュメントは比較的乾燥しており、答えを提供することを意図しています.問題の解決策を探している間、それに集中するのは、より簡単です.
私は、プロジェクトについて学ぶためにドキュメンテーションを読んで嫌いです.私が始めている新しいプロジェクトまたは私が学んでいる図書館であるならば、それは重要でありません.私には文脈がないので、それは時間の浪費のように感じます、そして、私が読んでいるものの間の接続を理解するのは難しいです.
その代わりに、私は自分自身で何かをして、失敗して、答えを探すドキュメンテーションに戻ってきます.その場合、私は少なくとも私が知らないものを知っています.
─
─
すぐに関連する情報を修正するときに修正する必要がある検索ツールを使用することができます.
サードパーティのライブラリの場合は、検索エンジンを利用して、プロジェクトのウェブサイトへの検索を制限することができます.
─
これは、Google、ビング、およびDuckduckgoを使用して同じ動作します.
コードドキュメントでは、コードベースを検索するために使用するのと同じツールを使用できます.
エディタ検索において
─慶喜3年(1666年)7月17日
─慶喜3年
唐辛子
- 1 , 566 , 914
─
docを検索するにはいくつかの利点があります.
あなたは、文書構造
あなたのトピックに関連するドキュメントのすべての部分を見つけるでしょう
─
APIリファレンス-ドライメソッドの説明
─
チュートリアルやガイドより多くのコンテキストを提供します.
─
ドキュメントの品質は大いに異なります.多くの場合、それは非常にアクセス可能なドキュメントではありません.読者がシステム知識を持っているという仮定があり、テキストには明示的に記述されていない.これは、新参者が少し失われる葉.
最も問題があるのは、クローズドソース、商用プロジェクトです.あなたがCodeBaseとそのドキュメンテーションの両方を維持している小さなチームを持っているならば、それはドキュメントを通って行って、それを理解しようとするどんな新しいセットの間でも月でありえます.
オープンソースプロジェクトは、通常、わずかにより良いです.良いドキュメンテーションのないものは、成功する可能性が低いです.
─
プロジェクトがチュートリアルまたはガイドを提供するなら、それをチェックするのは良い考えでありえます.よく似た問題を抱えて闘っているなら
それをカバーし、それを通過ガイドの一部をして下さい.よくやったガイドでは、完全に使用しているメカニズムを理解するために必要なコンテキストを提供します.
─
─
APIの説明は、最も技術的なドキュメントです.通常、それはかなり乾いていて、与えられたメソッドを使用することができる文脈の良い概要を欠いています.それはあなたのすべてのクラス、メソッド、引数を示し、あなたの処分で持っている出力.
─
利用可能な場合は、同じまたは同様のものの別の説明を通過します.多くの場合、他のリファレンスを参照することが多いので、最初に読んだ後にまだ失われている場合は、他のドキュメントがクリアされているかどうかを確認できます.
─
メソッドを使用すると、オブジェクトの内部状態を変更したり、出力を取得したりします.APIガイドは両方ともかなりよく説明するべきです.
─
多くの場合、メソッドは引数の多くの組み合わせで入力を受け入れます.ドキュメントでは、必要なすべてのものを得るためのすべてのオプションが表示されます.
─
ドキュメントを読むことは重要なスキルであり、練習によってのみ学ぶことができます.あなたの最初の試みとの闘争として落胆しないでくださいそれは時間とともに良くなる.
─
を読んでください.
Reference
この問題について(ドキュメントの読み方), 我々は、より多くの情報をここで見つけました https://dev.to/how-to-dev/how-to-read-the-documentation-j3pテキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol