次世代ヘルプ
Documentation
Getting Started
FAQ
Manual
動画による解説
インタラクティブチュートリアル
上記のものは本当に助けになっているのか?
あくまでトップダウン的であり、ユーザの疑問に答えきれない
結果としてIssue内を探さざるを得ない
半Forumになっているヘルプもある(PHPなど)
ほしい時にそこにない
一番ヘルプがほしいのは利用中 && 初回利用時
探しにいくのはかったるい、かといって利用中にいちいち出るのも邪魔くさい
分量が適切でないことがある
ドキュメントは積極的には整理がなされない傾向にある
多すぎる情報は探しづらい
JavaDocのような自動生成系も、意味のある情報にたどり着くことはあまりない
したがって本を買ったりQiitaに頼ったりすることになる
これらの情報源はすぐ古くなる
履歴がないと割と困る
マイグレーションしそこねた時など
これからのドキュメント
色々言葉で説明されるより使ってみたほうが早い
ドキュメント上にworking example / sandboxがあるとよい
Web系のツールはiframeで埋め込める
外部のチュートリアル著者と連携する
まとめ方が上手い人がいる場合は、公式からリンクする
ただ、老朽化していることがよくある
説明するよりUIで解決
してはいけないことはできないようにする
とはいえ「なぜできないか」が説明されていないと不自由な感触になってしまう