概要
書籍 Build Awesome Command-Line Applications in Ruby2
章
Be Helpful
詳細
man page など、helpオプション以外のより詳細を記述するドキュメントについて。
このドキュメントはセクションによって分類されるべき。
一般的なカテゴリは以下
| カテゴリ | 内容 |
|---|---|
| SYNOPSIS | 短い書式。どのようにアプリケーションを利用するか。 |
| DESCRIPTION | アプリケーションの目的や使い方など主に新規ユーザーがアプリケーションを理解するための内容 |
| OPTIONS | オプションの箇条書き。オプションの動作、影響について説明する |
| EXAMPLES | アプリケーションの利用例 |
| FILES | アプリケーションが利用するファイルのリスト |
| ENVIRONMENT | アプリケーションの動作に影響を与える環境変数の箇条書き |
| BUGS | 既知のバグや、予期せぬ動作について |
| LICENSE | -- |
| AUTHOR | authorとemailなど |
| COPYRIGHT | -- |
| SEE ALSO | アプリケーションと関係する他のコマンドやWebの情報へのリンク |
