[雑記] ユーザーズマニュアル
今回はただのぼやきです.情報量は 0 です.ご注意ください.
さて,今,自分自身が大学の研究のために作ったプログラムを後で見た人が動かせるようにするべく,ユーザーズマニュアルを書いていますが,これがまた面倒です.
リファレンスマニュアルなら Doxygen が自動生成してくれますが,ユーザーズマニュアルとなると... やはり手で書くしかないわけです.
コンパイルやインストール方法などは Autotools (Autoconf/Automake/Libtool) を使ってるので,お決まりの 3 行:
% ./configure % make % make install
で済むので割と楽(実際には ./configure に渡すオプションの説明も書きます)ですが.
ソースコードからユーザーズマニュアルを自動的に生成するソフトがいつの日か出ることを期待しつつ,その日が来るまでひたすら手でマニュアルを書くことにします.
トラックバック
トラックバック URI: https://www.pakunet.jp/hoge/trackback/2007021201
トラックバックはありません.