Sync Docs

Documentation Sync Skill

このスキルは、英語と日本語のドキュメントを同期的に更新します。

ドキュメントペア

以下のドキュメントペアを常に同期して更新する必要があります：

1. README

   • README.md (英語)
   • README_ja.md (日本語)

2. セットアップガイド

   • docs/setup.md (英語)
   • docs/setup_ja.md (日本語)

3. 使用方法ガイド

   • docs/usage.md (英語)
   • docs/usage_ja.md (日本語)

4. 開発ガイド

   • docs/development.md (英語)
   • docs/development_ja.md (日本語)

5. トラブルシューティングガイド

   • docs/troubleshooting.md (英語)
   • docs/troubleshooting_ja.md (日本語)

6. 環境変数サンプル

   • .env.example (バイリンガルコメント)

更新手順

1. 変更対象の特定

   • ユーザーの要求から更新が必要なドキュメントペアを特定
   • 関連する全てのドキュメントをリストアップ

2. 現在の内容を読み取り

   • 英語版と日本語版の両方を読み取る
   • 既存の構造とスタイルを確認

3. 同期的に更新

   • 英語版を更新
   • 同じ内容を日本語版にも反映
   • 一貫性を保つ

4. 検証

   • 両方のドキュメントが同じ情報を含んでいることを確認
   • リンクや参照が正しいことを確認

日本語ドキュメントのフォーマットガイドライン

太字の使用を避ける

❌ 避けるべき書き方：

- **機能名**: 機能の説明
- **設定項目**: 設定の説明

✅ 推奨される書き方：

- 機能名
  - 機能の説明
- 設定項目
  - 設定の説明

コロン「:」の使用を最小限にする

• 文末のコロンは日本語として不自然
• 本当に必要な場合のみ使用
• 箇条書きの構造化で代替

箇条書きでの構造化

• 見出しと説明を区別する際は、説明部分を1段階深くインデント
• 階層構造を明確にする
• 視覚的な可読性を重視

.env.example の更新

環境変数のサンプルファイルを更新する際：

1. バイリンガルコメント

   • 英語と日本語の両方でコメントを記載
   • 日本語を優先して上に配置

2. 例

# OneDriveユーザーとフォルダーの指定
# Specify OneDrive users and folder paths
SHAREPOINT_ONEDRIVE_PATHS=user@domain.com:/folder/path

重要な注意事項

• 必ず両方更新: 片方だけの更新は厳禁
• 一貫性の維持: 技術用語や構造を統一
• リンクの確認: 相対パスや参照が正しいか確認
• フォーマットの統一: 日本語ガイドラインに従う

スキルの動作

1. 更新対象のドキュメントペアを特定
2. 両方のファイルを読み取り
3. 英語版を更新
4. 日本語版を対応する内容で更新
5. 変更内容をユーザーに報告
6. 必要に応じて品質チェックを実行

Converted and distributed by TomeVault — claim your Tome and manage your conversions.