回答編集履歴
3
逆引きリファレンスの英語表記を追加
test
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
-
まず注意が必要なことは、ライブラリのドキュメントというのは多くの場合、正引きのリファレンスになっているということです。これは「機能があって、それに対して機能の説明がある」というものです。逆引きリファレンスですと「やりたいことがあって、その方法の説明がある」というものになりますが、これを公式で作っていることは少ないです(多少のサンプルはあっても、それは始めるために必要な程度)。
|
|
5
|
+
まず注意が必要なことは、ライブラリのドキュメントというのは多くの場合、正引きのリファレンスになっているということです。これは「機能があって、それに対して機能の説明がある」というものです。逆引きリファレンス(英語圏ではcookbookと呼ばれる)ですと「やりたいことがあって、その方法の説明がある」というものになりますが、これを公式で作っていることは少ないです(多少のサンプルはあっても、それは始めるために必要な程度)。
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
2
おかしな日本語を修正、説明を補強
test
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
-
まず注意が必要なことは、ライブラリのドキュメントというのは多くの場合、正引きのリファレンスになってい
|
|
5
|
+
まず注意が必要なことは、ライブラリのドキュメントというのは多くの場合、正引きのリファレンスになっているということです。これは「機能があって、それに対して機能の説明がある」というものです。逆引きリファレンスですと「やりたいことがあって、その方法の説明がある」というものになりますが、これを公式で作っていることは少ないです(多少のサンプルはあっても、それは始めるために必要な程度)。
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
@@ -24,6 +24,6 @@
|
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
27
|
-
それでもわからないことは、メーリングリストやStackOverflowなどで検索することになるでしょう。
|
|
27
|
+
それでもわからないことは、メーリングリストやStackOverflowなどで検索・質問することになるでしょう(開発者がそこを見ていることが多いからです)。
|
|
28
28
|
|
|
29
29
|
私が現時点で思いつくドキュメントの読み方はこんなところです。参考になれば幸いです。
|
1
文体を統一
test
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
|
-
1. まず、Getting StartedやIntroduction、Motivation、Overviewといった項を読み、そのライブラリが何を目的としているのかを理解す
|
|
13
|
+
1. まず、Getting StartedやIntroduction、Motivation、Overviewといった項を読み、そのライブラリが何を目的としているのかを理解します。これは、自分が解決したい問題にライブラリ自体が合致するかを確認することも読む目的に含みます
|
|
14
14
|
|
|
15
15
|
2. 次に、そのライブラリを使ったサンプルコード、チュートリアルを読みます。これによって、ライブラリの簡単な使い方を学びます。ただし、それはエラーハンドリングやコーナーケースを廃したものであることが多いため、この段階のコードをそのまま自分のプロダクトコードに持っていくと痛い目に合う可能性があります
|
|
16
16
|
|