クライアントのためにウェブサイトを作成して、管理画面を手渡す場合に、成果物の一部としてマニュアル、ドキュメントを渡すことはありますか？
マニュアルを作成するにあたって苦労するポイントとしては、
- 管理画面の UI が更新されるとドキュメントも更新しなくてはならない
- 毎回繰り返しの部分が多くて辛い
- 有料のものだったり誰かが作ったものの場合に、変更・追加ができない
- 他社のロゴなどが入っているとお客さんに渡しにくい
というものがあります。
有志が集って作るマニュアルがある
そんなみなさんにオススメなのが、WordPress コミュニティの有志が集まって作成している “WordPress ユーザドキュメント” です。
このマニュアルの特徴は、有志が集ってみんなで作成しているということです。そのため、マニュアル制作のための手間が分散される、特定の人／会社の持ち物ではない、変更したい内容があればプルリクエストを送ったり、フォークして自分だけのパートを追加したりできるという利点があります。
このプロジェクトの目標は、
WordPress の管理画面（ダッシュボード）の操作方法をメインに、これを読めば WordPress の基本操作は大丈夫というマニュアルを目指しています。
とのことです。現在の目次の構成を見ると、
- ログインの方法
- 投稿方法
- 固定ページ
- 外観
- プラグイン
- ユーザー
- 設定
- アップデート
という章立てとなっており、すべてのテーマに共通する基本操作に内容を絞っているのが分かります。
作成は Github を利用して行われている
このマニュアルの作成は、
- Github を利用して
- 随時、あるいは、WordCamp のコントリビューターデイの貢献活動のひとつとして
行われています。ライセンスは、WordPress ソフトウェアと同じく GPL バージョン 2 またはそれ以降の互換ライセンス となっています。
そもそもは、WordCamp Kansai 2016 のコントリビューターデイのひとつの班から始まったそうで、その後、WordCamp Tokyo のコントリビューターデイでも引き続き執筆が続けられています。
参加方法
wckansai2016/wordpress-document: WordPress ユーザドキュメント on Github.com
このレポジトリの CONTRIBUTING.md に手順が詳しく書かれているので、興味のある方は参加してみましょう。送ったプルリクエストがマージされると、ドキュメントのページの最下部に、貢献者としてアイコンが表示されるようです。
ユーザードキュメントについて読める場所
WordCamp のコントリビューターデイの開催を担当したり、ユーザードキュメントの作成を主導したりしていた方のブログ記事をご紹介して締めたいと思います。
コメントを残す