6.1 KiB
6.1 KiB
FF14 攻略Wiki ワークスペース運用規則
本ワークスペース(z:\FF14攻略)におけるすべての作業およびAIエージェントの自律動作において、本規則を常に最優先で遵守してください。
1. プロジェクト方針&Wiki構造の維持
本リポジトリは、ファイナルファンタジーXIV(FF14)の攻略情報・ジョブ立ち回り・クロスホットバー(XHB)設計・ギャザクラ育成ロードマップを集約した**「ローカルHTML型Wikiナレッジベース」**です。
1.1 【最重要】1ページ1コンテンツの原則&積極的なフォルダ・ページ分割
- 1ページ1コンテンツの徹底:
- 極力1つのHTMLファイルには単一の明確なトピック(例: 「召喚士のXHB配置」「吟遊詩人の戦歌ローテーション」「ギャザクラ全NPC座標一覧」など)のみを記述してください。
- 1つの長大なページに複数のジョブや無関係なテーマを詰め込むことは禁止とし、トピックごとに明確に分割してください。
- 積極的なフォルダ分類(階層化):
- 大カテゴリごとにフォルダを作成し(例:
jobs/summoner/,jobs/bard/,crafter_gatherer/,xhb/,multiplayer/等)、各フォルダ内に目的別のHTMLページを整理して配置してください。 - 各フォルダには必要に応じて案内用トップページ(
index.html)を設置してください。
- 大カテゴリごとにフォルダを作成し(例:
1.2 【最重要】マクロ設定・機能解説の完全詳細記述
- マクロの全行・全設定の完全記述:
- マクロ設定やゲーム内機能を解説する際は、概要のみで済ませず、マクロの全コード行(
/micon、代名詞<t>/<me>/<mo>、ウェイト<wait.1>等)を省略なく完全に記述してください。 - なぜその記述順序なのか、行ごとの役割、連打時の挙動、ターゲットがいない場合のフェイルセーフ仕様、設定時の注意点まで余すところなく詳細に解説してください。
- マクロ設定やゲーム内機能を解説する際は、概要のみで済ませず、マクロの全コード行(
1.3 【最重要】デザインテンプレート「Seesaa Wiki ニュートラルグレー」の厳格適用
- 全ページのUIデザインは、日本の定番ゲームWikiスタイルである**「Seesaa Wiki ニュートラルグレー」**を踏襲してください。
- 共通CSSの適用:
- すべてのHTMLページは
common/css/seesaa_neutral_gray.cssをリンクして読み込んでください。
- すべてのHTMLページは
- デザイン規範:
- 背景色: 落ち着いたニュートラルグレー系(
#f0f0f2〜#e6e6e9) - メインコンテンツ: 白色(
#ffffff)、視認性の高いダークグレー本文(#2b2b2b) - 2カラムレイアウト:
- 左サイドバー: メニュー(カテゴリー一覧、主要ページリンク、サイト内検索、最近の更新)
- 右メインコンテンツ: パンくずリスト、ページタイトル、最終更新日、本文、ページネーション
- 見出しスタイル:
- H2(大見出し): ニュートラルグレーの帯見出し(
#646c7aまたは#e8e9ecに左太線アクセント) - H3(中見出し): 下線ボーダー+左縦線アクセント
- H2(大見出し): ニュートラルグレーの帯見出し(
- テーブル・マクロ表示:
- テーブルヘッダー: 薄いグレー(
#ececf0) - マクロ枠(コードブロック): 背景
#f7f7f9、罫線#d8d8de、等幅フォント、コピー機能や詳細注釈を併記
- テーブルヘッダー: 薄いグレー(
- 背景色: 落ち着いたニュートラルグレー系(
1.4 ポータルページ(index.html)の常時同期
- 新規ページを追加、または構成を変更した際は、必ずトップポータル
index.htmlのサイトマップ、カテゴリーリンク、収録統計を同期更新してください。 - サイドバー共通メニューにも適宜最新のページ構造を反映させてください。
2. Gitバージョン管理&自動コミット運用規則
ユーザーからの明示的な指示がなくとも、変更作業を行った際は必ず自律的にGitコミットを実施してください。
2.1 コミットのタイミング
- ガイドの新規作成、既存ガイドの加筆・分割、ポータルの更新、設定変更などの作業が完了した際、変更内容(論理的単位)ごとに即時コミットを行ってください。
- 複数の無関係な修正を1つのコミットに混ぜず、適切な単位で分割してコミットしてください。
2.2 コミットメッセージの記法
- コミットメッセージは分かりやすい日本語で記述してください。
- プレフィックスを付与して変更種別を明示してください:
feat:: 新しい攻略ガイドの追加、新機能・新ページの追加fix:: スキル回し、マクロ構文、数値、座標、リンク等の誤り訂正docs:: 既存ガイドの解説追記、ポータルの説明文修正style:: Seesaa Wikiニュートラルグレーのデザイン調整、レイアウト改善refactor:: ページ分割、ディレクトリ整理、コードのリファクタリングchore:: 設定ファイルや運用規則の変更
2.3 コミットの実行手順
- 作業完了後、
git statusおよびgit diffで変更内容を確認する。 - 対象ファイルをステージング(
git add <files>)する。 - 日本語のコミットメッセージでコミット(
git commit -m "...")を実行する。 - コミットが正常に完了したことを確認する。
3. ファイル保存スタイル&文字コード規則
- 文字コード: 必ず UTF-8(BOMあり / UTF-8 with BOM) で保存してください。
- 改行コード: 必ず CRLF (
\r\n) で保存してください。 - 行末空白の完全除去: コード行、コメント行、空行の末尾に半角・全角スペースを残さないでください。
- 連続空行の防止: 空行は最大で「1行」とし、2行以上連続させないでください。