ドキュメント自体の説明
このサイトのドキュメント自体の構造や読み方などの説明。わりと事務的な話です。
質問、相談、要望など (フィードバック)
質問、相談、要望、バグ報告、雑談、交流などのフィードバックについてのページをご覧ください。
ひとつだけここで紹介します。
気軽にチャットで質問や相談などができる 公開Slack がありますので、ぜひご利用ください。 (Slack登録ページで、自身のメールアドレスと登録トークンを入力すると招待メールが送信されます)
- Slack登録ページ
- https://dbflute-slack-invitation.herokuapp.com
- Slack登録トークン
- "海" の英単語を小文字三文字で
- Slack自体のURL
- https://dbflute.slack.com/messages/
※仕組み的に 誰でも閲覧できるチャット になりますので、それを前提に投稿をお願いします。将来はチャットの内容をサイトで自動公開できるようにしたいとも考えています。ゆえに "公開Slack" と銘打っています。
ドキュメントのプルリクエスト
ドキュメントの修正、追加などプルリクエストを募集しています。
- Githubリポジトリ
- https://github.com/dbflute/dbflute-document
- 修正方法
- webディレクトリ配下にHTMLを直接修正 (web直下のreadme_ja.txtを参照)
※それぞれのHTML上のヘッダーはダミーです。デプロイ時のGroovyスクリプトで共通のヘッダー定義に差し替えられます。 id="content" の付いた div タグ内がそれぞれのドキュメントの内容となります。
よろしくおねがいします！
ページカテゴリ
大きく以下のように分かれています。
- 紹介 (Introduction)
- 紹介・概念の説明など
- チュートリアル (Tutorial)
- チュートリアル (ドキュメント全体のエントリ)
- 環境 (Environment)
- 環境周りの話 (環境構築、インストールなど)
- マニュアル (Manual)
- 機能マニュアル、リファレンス、トピック
DBFluteが初めての人は、まずは "紹介" を、以降は "チュートリアル" から必要な情報を辿ります。
詳細・関連リンク
既にこのページにも登場していますが、フォルティッシモや、フォルテなどの強弱記号にリンクがくっ付いています。 これは、そのとき話題になっている内容を補足するためのリンクを示し、強弱によってニュアンスが変わります。
-
フォルティッシモ :
- その話題の詳細が書かれたページ
-
メゾピアノ :
- その話題(の一部)に関連するページ
-
ピアニッシモ :
- その話題に含まれる用語を説明するページ
フォルティッシモは、"とにかくその話題に関して詳しく知るためにそっちを見て下さい" の意に等しいです。それ以外は、"必要であればリンク先をどうぞ" というニュアンスです。
詳細・関連・用語と、三つのカテゴリに分けられるのですが、グレーゾーンも多く発生し、逆に紛らわしい曖昧さが残ってしまう可能性があるので、あえて "強弱" という曖昧な表現を利用しています。(将来的には、まだ利用していないメゾフォルテとかも登場するかもしれません)
対応バージョン
個々の機能の対応バージョンの記載については、ドキュメント公開時点(0.9.6.9)では存在しないため、 それまでにおける対応バージョンは、申し訳ありませんが ChangeLog から追って頂くことになります。
その後のバージョンで対応された機能に関しては、対応バージョンを書いていく予定です。 また、以前のバージョンに関しても、判明した時点で逐一できるものは記述していく予定です。
対応プログラム言語
このサイトのドキュメントは、Java版のDBFluteを想定しており、DBFlute.NET(C#版)に関しては別サイトとなります。 但し、共通の話題はたくさんあります。
対応自然言語
ドキュメント公開時点(0.9.6.9)では、日本語のドキュメントのみ対応しています。
対応ブラウザ
以下ブラウザの最新版を想定しています。
- Safari
- FireFox
- Chrome
- IE (旧バージョンであるIE6, IE7ではデザイン崩れあり)
Windows上では、メイリオ(フォント)が利用可能な環境であることが推奨されます。
作成中について
ドキュメント公開時点(0.9.6.9)では、まだたくさんの作成中のページがあります(公開時点ではイチローの打率くらい)。そのページには "TODO jflute" という文字が入っています。また、存在しないページへのリンクは、クリックできないリンクになり、かつ、"(Making)" という文字が追加されています。これらは、都度都度作成されていく予定です。
