FreeBSD プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:

The FreeBSD Project

テクニカル ライター:

The King of Toasters

プロジェクト名:

欠落している man ページの記述、マニュアル ページに EXAMPLE セクションを追加する

プロジェクトの長さ:

標準期間（3 か月）

プロジェクトの説明

不足している man ページを作成します。

不足している manpage のリストは、https://wiki.freebsd.org/MissingManpages にあります。そのリストからできるだけ多くのマニュアル ページを作成します。メンターの助けを借りて、該当する man ページに関する背景情報や詳細を確認できる、そのページの作成者または最近ソースファイルを変更した人物を探します。

man ページに EXAMPLE セクションを追加する:

FreeBSD のマニュアル ページには、そこに記載されているユーティリティやコマンドの基本的な使用方法が説明されている EXAMPLE セクションが多くあります。FreeBSD の Wiki には、例のないマニュアル ページのリストがあります（https://wiki.freebsd.org/ManPagesWithoutExamples）。例を追加するのが適切な場合は、できるだけ多くの例を man ページに追加します。これらのセクションでコマンド / ユーティリティを紹介する一般的な方法（まずはクイック スタート、その後はより高度な例など）を考え、同様のユーティリティやコマンドを説明する man ページに適用します。これにより、例のアプローチが一貫し、読者が情報を簡単に見つけられるようになります。