21.6. ドキュメントのカスタマイズ

ドキュメンテーション は、特にカスタマイズを行う場合に、どのソフトウェアにとっても重要です。ドキュメントはさまざまな場所、パーソナル コンピュータまたはネットワーク ドライブ上のテキストドキュメント、wiki、ナレッジ ベース、またはコードが格納されているリポジトリに直接、置くことができます。これらの場所の中には、特にプロジェクトに初めて参加する人にとって、他の場所よりも見つけるのが難しいものがあります。

簡単に見つけられるように、コードが置かれている場所の近くにドキュメントを保管することをお勧めします。 README ファイルに入れる人もいれば、別のファイルを作成する人もいます。MaharaにはMaharaの README ファイルが付属しているため、それにプロジェクト固有のドキュメントを追加すると、常に競合が発生します。そのため、クライアント固有のドキュメントをすべて保持できる CUSTOMISATIONS ファイルがあります。

コードベースにサンプル ファイルが用意されています。コンテンツをフォーマットするために Markdown を使用するように設定されています。

警告

パスワード、キー、個人情報などの機密情報をそのファイルに 入れない でください。ただし、別の場所に安全に保管してください。 CUSTOMISATIONS ファイルがプロジェクトリポジトリに追加されるため、変更履歴が保持されます。コードベースがより広く利用可能になった場合、その機密情報が公開されます。

このファイルは htdocs フォルダの外にあるため、ウェブサーバにデプロイされず、ブラウザからアクセスできます。ただし、 htdocs フォルダのコンテンツだけをサーバにアップロードする必要があります。