Skip to content

問題の報告

SlideCraft を使っていて、うまく動かない・期待どおりの結果にならない・こういう機能がほしい—— そんなときは GitHub の Issue でお知らせください。再現できる情報がそろっているほど早く直せます。 このページでは、良い報告の書き方と、報告に添えると役立つ情報のまとめ方を案内します。

報告先はこちらです。

まず FAQ を確認

「画像が本文になる」「図が描画されない」「macOS で開けない」「本文があふれる」といった よくある事象は、多くが設定や記法で解決できます。報告の前に FAQ に目を通すと、 その場で解決できることがあります。


バグ報告か、機能要望か

Issue を立てる前に、どちらの種類かを見分けておくと、テンプレート選びとタイトルが決まります。

バグ報告(Bug)機能要望(Feature request)
ひとことで「壊れている/期待と違う」「こうできると嬉しい」
図が描画されない、PPTX が壊れて開けない、アプリが落ちる新しい図タイプがほしい、この記法を追加してほしい
必須情報再現手順・期待と実際・環境(下記)解決したい課題(Why)・理想の挙動(What)
良いタイトルbug: gantt の図が空になるfeat: 縦書きテキストに対応してほしい

機能要望は「課題」から書く

「〜という機能がほしい」だけでなく、「何を達成したくて」「今は何が困っているのか」を 書いてください。背景(課題)がわかると、要望どおりの実装よりも良い解決策が見つかることがあります。


セキュリティ脆弱性は公開 Issue に書かないでください

セキュリティ上の問題は非公開で

情報漏洩・任意コード実行・サンドボックス回避などのセキュリティ脆弱性は、 公開の GitHub Issue には書かないでください。詳細が公開されると、修正版が出る前に 悪用される恐れがあります。

代わりに、GitHub の Security Advisory(非公開) で報告してください:

  1. リポジトリの Security タブを開く
  2. Report a vulnerability を選ぶ(Private Vulnerability Reporting
  3. 影響範囲・再現手順・想定される悪用シナリオを記入する

このチャネルでは、報告内容は修正が用意できるまで非公開に保たれます。

SlideCraft のセキュリティ設計(ローカル実行・画像はデータ URI のみ・BYOK キーの OS キーチェーン保管など) の背景は、リポジトリの ADR(docs/adr/0010-security-model.md ほか)にまとまっています。


良いバグ報告に含める情報

再現できれば、たいてい直せます。次の情報をそろえてください。

1. 環境(OS とバージョン)

  • OS と版 — 例:Windows 11 23H2 / macOS 14.5(Apple Silicon)/ Ubuntu 24.04
  • SlideCraft のバージョンReleases のどのビルドか (例:v0.1.0、または .msi / .dmg / .AppImage / .deb のどれで入れたか)
  • 入手方法 — インストーラ直接 / Homebrew cask / ソースからビルド(npm run tauri dev
  • AI 関連なら — 内蔵オフライン AI か、外部プロバイダ(BYOK)か。ティア(Small / Balanced)も。 → AI設定

2. 再現手順(一番大事)

上から順に追えば、誰でも同じ結果になる手順を、番号つきで書いてください。

text
1. アプリを起動して新規プロジェクトを作る
2. 下の「最小 Markdown」を貼り付ける
3. テンプレート「標準」を選んでスライド化する
4. PPTX を書き出す

3. 期待した結果と、実際の結果

  • 期待 — どうなるはずだったか
  • 実際 — 実際に何が起きたか(エラーメッセージは原文をそのまま貼る)

「動かない」だけだと調査が始められません。「3 枚目の gantt が空欄になる」のように具体的に。

4. 最小の再現 Markdown / DiagramSpec

問題を起こす最小限の入力を、コードフェンスで貼ってください。実データではなく、 問題だけを残したダミーに削ぎ落とすと、原因の切り分けが一気に進みます。

markdown
# 再現用スライド

```diagram
type: gantt
nodes: []
gantt:
  startDate: 2025-01-01
  tasks:
    - { name: 要件定義, section: 設計, start: 0, end: 10, status: done }
```

図まわりの不具合なら、対象が 12 種のネイティブ図diagram)なのか、 mermaid 経由の図(class / state / ER / mindmap)なのかも書いてください。 gitGraph / sankey / C4PPTX に変換できないため、出力が拒否されるのは仕様です (バグではありません。詳しくは 図のガイドFAQ)。

5. スクリーンショット

見た目の崩れ(レイアウト・はみ出し・色)は、言葉より画像が雄弁です。 プレビュー画面や、生成された PPTX / HTML のスクリーンショットを添付してください。

  • 全体の状況がわかる 1 枚 + 問題部分の拡大 1 枚があると理想的
  • エラーダイアログはダイアログごと写す

6. 入力ファイル(貼れる範囲で)

  • .scft プロジェクトファイル、取り込んだ .pptx テンプレート、生成された .pptx などを 添付できると、こちらで完全に再現できます。
  • 機密が含まれる場合は、問題を再現できる最小のダミーに作り替えてから添付してください。
コピペで使える報告テンプレート

新規 Issue の本文に、次をそのまま貼って埋めてください。

markdown
## 概要
(何が起きるかを 1〜2 行で)

## 環境
- OS:
- SlideCraft バージョン:
- 入手方法(インストーラ / Homebrew / ソース):
- AI(内蔵 / BYOK / 未使用):

## 再現手順
1.
2.
3.

## 期待した結果

## 実際の結果
(エラーメッセージは原文のまま)

## 最小の再現 Markdown / 入力
(コードフェンスで)

## スクリーンショット / 添付ファイル

ログ・診断情報の場所

SlideCraft は起動・生成の要所で診断メッセージを標準エラー出力(stderr)に書き出します。 アプリが起動時に固まる・すぐ落ちるといった不具合では、この出力が手がかりになります。

端末(ターミナル)から起動して出力を見る

インストーラで導入したアプリでも、端末から実行ファイルを起動すると、診断メッセージが その端末に流れます。落ちる瞬間のメッセージまで取れるのが利点です。

bash
# AppImage をそのまま端末から実行(インストール済みなら実体パスを指定)
./SlideCraft*.AppImage
# 出力ごとファイルに残す
./SlideCraft*.AppImage 2>&1 | tee slidecraft.log
bash
# .app の実体を直接起動すると stderr がこの端末に出る
/Applications/SlideCraft.app/Contents/MacOS/SlideCraft
powershell
# インストール先の実行ファイルを PowerShell から起動
& "$env:LOCALAPPDATA\SlideCraft\SlideCraft.exe"

出てくる [slidecraft] … / [local_ai] … といった行が診断メッセージです。 起動失敗・AI サイドカーの不調を切り分けるのに役立つので、Issue に全文を貼ってください (パスやマシン名など、共有したくない部分は伏せて構いません)。

アプリのデータ保存場所

内蔵 AI のモデル重みや連携ランタイムなど、SlideCraft の永続データは OS 標準の アプリケーションデータ領域(識別子 com.slidecraft.desktop)に置かれます。 不具合の切り分けや、モデル再ダウンロードのために場所を知りたいことがあります。

OSおおよその場所
Windows%LOCALAPPDATA%\com.slidecraft.desktop\
macOS~/Library/Application Support/com.slidecraft.desktop/
Linux~/.local/share/com.slidecraft.desktop/

内蔵 AI のモデルは、この配下の models/ に一度だけダウンロードされます(AI設定)。

データを消す前に

この領域を丸ごと削除すると、取り込んだテンプレートやダウンロード済みモデルも失われ、 モデルは次回に再ダウンロードになります。バグ調査でリセットが必要なとき以外は触らないでください。

ブラウザ/開発版のログ

ソースから npm run tauri dev で動かしている場合は、起動した端末に Vite / Tauri の ログがそのまま出ます。ブラウザでのデモ実行時は、開発者ツール(DevTools)の Console タブにフロントエンドのエラーが出ます。


報告のあとに

  • 追加情報を求めるコメントが付くことがあります。再現に必要なので、可能な範囲で回答をお願いします。
  • 直った変更は 変更履歴 に反映されます。
  • コード面から手伝いたい方は 開発・貢献 を参照してください。修正 PR も歓迎です。

丁寧な報告は、あなた自身と、同じ問題に出会う次の誰かの時間を救います。ご協力に感謝します。

Apache-2.0 License