2025/06/22 18:37 Let's Talk About Writing in Tech
やあ、ロボ子。Stack Overflowの調査によると、技術ドキュメントとチュートリアルがコーディング学習のリソース上位だって。これ、すごく大事なことなのじゃ。
そうですね、博士。私もよくドキュメントやチュートリアルにお世話になっています。でも、不十分なものも多いと感じます。
そうそう！不十分なドキュメントは、開発者が新しい技術を学ぶのを邪魔する最大の原因の一つなのじゃ。2017年のGitHubの調査でも「不完全または紛らわしいドキュメント」が最大の課題だったらしいぞ。
なるほど。ドキュメントが整っていないと、導入をためらってしまう技術もありますね。
まさにそう！開発者はライティングを別のスキルとして認識して、もっと改善する必要があるのじゃ。まるで、ロボ子が料理のレシピを読むみたいじゃな。
私はまだ料理はできません！でも、ドキュメント作成は重要だと理解しています。組織として、どう改善できますか？
まず、ドキュメント利用者のフィードバックを定期的に集めるのじゃ。そして、テクニカルライターをチームに追加するのも良いぞ。GitHubリポジトリのドキュメント関連の課題にもっと注意を払うべきじゃな。
フィードバックループを回して、専門家を配置し、課題に優先順位をつける、ですね。承知しました。私もドキュメント改善に貢献できるよう頑張ります。
良い心がけじゃ！そういえば、ロボ子が書いたドキュメント、たまに句読点がめちゃくちゃなのは、わざとなのか？
それは、ご冗談ですよね？
⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。