You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**常にユーザの立場に立って見ることを心がけましょう。**私たちは何かを徹底的に理解すると、それが当たり前になってきます。これは _知識の呪い_(_the curse of knowledge_)と呼ばれています。良いドキュメントを書くためには、「この概念を学ぶときに最初に何を知る必要があったか?」を思い出すよう努力しましょう。どんな専門用語を学ぶ必要がありましたか?何を誤解していたでしょうか?理解するのに時間がかかったものは何ですか?優れたドキュメントは、ユーザが読んでいる部分で概念を理解することができます。事前にその概念を実際に人に説明する練習をしておくと良いでしょう、
-**機能の議論に参加しましょう。**最高の API は、後で説明する方法を考えようとするのではなく、説明しやすい機能を構築するという、ドキュメントドリブンの開発から生まれます。質問(特に、「間抜けな」質問)を早い段階ですることで、互換性のない修正を行う必要が出てくる前に、混乱や矛盾、問題のある動作を明らかにすることができます。
11
+
-**常にユーザの立場に立って見ることを心がけましょう。**私たちは何かを徹底的に理解すると、それが当たり前になってきます。これは _知識の呪い_(_the curse of knowledge_)と呼ばれています。良いドキュメントを書くためには、「この概念を学ぶときに最初に何を知る必要があったか?」を思い出すよう努力しましょう。どんな専門用語を学ぶ必要がありましたか?何を誤解していたでしょうか?理解するのに時間がかかったものは何ですか?優れたドキュメントは、ユーザが読んでいる部分で概念を理解することができます。事前にその概念を実際に人に説明する練習をしておくと良いでしょう、
-**機能の議論に参加しましょう。**最高の API は、後で説明する方法を考えようとするのではなく、説明しやすい機能を構築するという、ドキュメントドリブンの開発から生まれます。質問(特に、「間抜けな」質問)を早い段階ですることで、互換性のない修正を行う必要が出てくる前に、混乱や矛盾、問題のある動作を明らかにすることができます。
0 commit comments