Fog Creek Software
Stack Overflow

Q&Aの答よりもやや長くて詳しい情報を、創立10周年近いStackOverflowがドキュメンテーションのクラウドソース化に挑戦

次の記事

TeslaとUberの意外に多い共通点

Stack Overflowは2008年の発足から今日までに、プログラミング関連の質問をする場所の定番のようなサイトに育ってきた。そして今回同サービスは、そのコミュニティの力を利用する新しいプロダクトを立ち上げようとしている。それはピアレビューされる技術的ドキュメンテーションの貯蔵庫(リポジトリ)だ。Stack Overflow Documentationと名付けられたこの新しいプロダクトは、各システム(プログラミング言語、ライブラリなど)に付随するマニュアルを補うと同時に、場合によっては、モアベターなドキュメンテーションとして、既存のマニュアル類を置換するかもしれない。

“これまでQ&Aでやってきたことと同じく、Documentationもデベロッパーの現実的な問題を解決することが目標だ”、StackOverflowのVP Jay Hanlonが、今日の発表声明でこう述べている。“プログラミングに関する世界中の良質な知識の和を、その上にわれわれが育っていく土壌として、個々の個人やチームに作れるもの以上に役に立つものを、作っていけるだろう”。

Organization of Documentation

StackOverflowのチームによると、Q&AのタグとDocumentationのタグは共通にする。同サイト上に、利用できるタグは5万近くある。Documentationリポジトリ上のドキュメンテーションは原則としてユーザーが書き、言語のさまざまな機能や、そのほかの技術、プロダクトなどが対象となる。

またStackOverflow Documentation上のドキュメンテーションは、機能等の単なる定義を超えて、実際的な用例まで含むものとする。そこで、ページの編成は下図のようになり、最初に用例(Examples)が来て、そのあとにパラメータとシンタックスに関する情報がある。さらにその下には、追記的なコメント(Remarks)を置く。

Organization of Individual Topic Page
[各ドキュメンテーションのお肉は用例である]

上のような、Documentationのページは、非公開ベータの間に生まれ育っていった。始まりは昨年の秋だった。重要なことのひとつは、ほかのソースから既存のドキュメンテーションをインポートするのではなく〔それはリンクと注記があれば十分!〕、コミュニティがコンテンツをスクラッチで作るものとする。Q&Aでも、その流儀…リアルでライブでオリジナルな対話…だからうまくいったのだ。今Googleの検索でプログラミング関連の質問を検索すると、結果の上位にはほとんどつねに、StackOverflow上のQ&Aが並ぶ。同じくDocumentationも、Googleの上位を占めるだろう。

[原文へ]
(翻訳:iwatani(a.k.a. hiwa))