ユーザーガイド
目的
このセクションでは、RDEToolKitの詳細な使用方法と高度な機能について説明します。基本的なインストールと初回実行を完了した後に、より効果的にRDEToolKitを活用するための情報を提供します。
主要トピック
基本概念
- 構造化処理とは - RDEToolKitの中核となる概念と処理フロー
- 処理モード - 4つの処理モードの特徴と使い分け
- ディレクトリ構造 - RDEプロジェクトの標準的なファイル構成
- 構造化処理開発ガイド（概要） - 実践的な開発プロセスと学習の流れ
設定とカスタマイズ
- 設定ファイル - rdeconfig.yamlとpyproject.tomlによる動作制御
- Magic Variable - 動的なメタデータ置換機能
- gen-config CLI - 用途別テンプレートや対話形式でrdeconfig.yamlを生成
テンプレートファイル
- テンプレートファイルガイド -
invoice.schema.json/invoice.json/metadata-def.json/metadata.jsonの役割と構造 - init CLI - 主要テンプレートとディレクトリ骨格を自動生成
- リポジトリ内のサンプル:
templates/tasksupport/invoice.schema.json,templates/tasksupport/metadata-def.json
実践的な使用方法
- CLIツール - コマンドライン操作の詳細
- 構造化処理開発ガイド（実装編） - 実データを用いた開発ハンズオン
- バリデーション - データ品質の検証方法
高度な機能
- Docker使用方法 - Dockerを使用した環境構築と実行
使用方法の流れ
- 概念理解: 構造化処理とはと構造化処理開発ガイドで全体像を把握
- テンプレート準備: init CLIやgen-config CLIで初期ファイルを生成
- 環境設定: 設定ファイルやテンプレートファイルガイドを基にrdeconfig.yamlやinvoice/metadata定義を調整
- 実践応用: CLIツールやバリデーションでワークフローを運用し、必要に応じて高度な機能へ拡張
サポートリソース
ドキュメント
- API リファレンス - 全機能の技術仕様
- 開発者ガイド - コントリビューション方法
- 構造化処理開発ガイド - テンプレート作成から検証までの実践手順
コミュニティ
- GitHub Issues - バグ報告と機能要望
- GitHub Discussions - 質問と情報交換
学習の進め方
RDEToolKitを効果的に学習するには、まず構造化処理とはで基本概念を理解し、その後に具体的な用途に応じたトピックを参照することをお勧めします。
次のステップ
- 初めての方: 構造化処理とはから開始
- 設定を変更したい方: 設定ファイルを参照
- 高度な機能を使いたい方: Docker使用方法を確認