Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

Ruby | CLI | Be Helpful | Writing Good Help Text and Documentation

概要

書籍 Build Awesome Command-Line Applications in Ruby2

Be Helpful

詳細

ヘルプテキストや明確で、簡潔で、正確で、便利なドキュメントは重要。
ヘルプや、ドキュメントにはいくつかの決まりごとがある。

1センテンスにまとめられた概要である banner は新規ユーザーに向けて教育するために必要です。
その他には、'DESCRPITION' や 'EXAMPLE' を含んだ man ページ。
これは banner よりもさらに深い情報を含む。