ワークフロー
Eddieの5段階ワークフローは、AI支援ドキュメント作成のために設計されています。
哲学
従来のドキュメントワークフローは以下のいずれかです：
- ❌ 硬直的すぎる: CMSシステムはテンプレートに強制する
- ❌ 自由すぎる: 生のMarkdownフォルダーが混沌とする
Eddieは構造化された柔軟性を提供します：明確なステージでありながら、厳格なルールはありません。
5つのステージ
0.prompt🤖 - AIプロンプトテンプレート
目的: AI支援でコンテンツのアイデアを生成する。
ここに含めるもの:
- Claude Codeプロンプト
- ChatGPT会話のきっかけ
- インタビューの質問
- リサーチのクエリ
例: 0.prompt🤖/api-documentation-prompt.md
RESTエンドポイントのAPIドキュメントを作成する。
含めるもの：
- エンドポイントURLとメソッド
- リクエストパラメータ
- レスポンス形式
- JavaScriptとPythonのサンプルコード
- エラーコードClaude Codeでの使用法:
ユーザー: 「0.prompt🤖/api-documentation-prompt.mdのプロンプトを使用して
/usersエンドポイントを文書化してください」
Claude: [プロンプトを読んでドキュメントを生成]1.source📦 - 生の素材
目的: 未加工のコンテンツを保存する。
ここに含めるもの:
- 会議の文字起こし
- インタビュー録音（テキスト化）
- リサーチノート
- コピー&ペーストした記事
- コードサンプル
- スクリーンショット
例: 1.source📦/customer-interview-20250310.md
# 顧客インタビュー - 田中太郎 - 2025-03-10
Q: 最大の課題は何ですか？
A: ドキュメントがNotion、Googleドキュメント、Confluenceに散在しています...
Q: 情報をどのように検索していますか？
A: 通常はCmd+Fか、Slackでチームメイトに聞きます...ガイドライン:
- フォーマットは気にしない
- 元の文言を保持
- メタデータを追加（日付、ソース、著者）
2.sampling✂️ - 抽出されたコンテンツ
目的: ソースから重要な洞察を洗練して抽出する。
ここに含めるもの:
- 箇条書きの要約
- 重要な引用
- 抽出されたコードスニペット
- 分類された発見
例: 2.sampling✂️/customer-pain-points.md
## ドキュメントの課題（5件のインタビューから）
### 発見
- 「検索でドキュメントが見つからない」（3件の言及）
- 「どんなドキュメントが存在するか分からない」（2件の言及）
### メンテナンス
- 「ドキュメントがすぐに古くなる」（4件の言及）
- 「更新する場所が多すぎる」（3件の言及）
### ツール
- Notion: UIは良いが、検索が悪い
- Confluence: 強力だが、圧倒的
- Googleドキュメント: シンプルだが、構造がないガイドライン:
- 類似のアイデアをグループ化
- 冗長性を削除
- ソース参照を保持
- 箇条書きを自由に使用
3.plot📋 - ドキュメントのアウトライン
目的: 最終ドキュメントの構造を計画する。
ここに含めるもの:
- 目次
- セクション見出し
- セクションごとの重要ポイント
- 他のドキュメントへの内部リンク
例: 3.plot📋/documentation-guide-outline.md
# ドキュメントベストプラクティスガイド
## 1. はじめに
- 優れたドキュメントが重要な理由
- よくある落とし穴
## 2. 構造
- 情報アーキテクチャ
- ナビゲーション設計
- [[workflow.md]]へのリンク
## 3. 書き方
- 巧妙さより明瞭さ
- 能動態
- コードサンプル
## 4. メンテナンス
- レビュースケジュール
- バージョン管理
- 発見のための[[vector-search.md]]へのリンクガイドライン:
- まだ完全な文章を書かない
- 論理的な流れに焦点を当てる
- リサーチが必要なセクションをマーク
- 他のドキュメントを参照するにはWikiリンクを使用
4.publish📚 - 最終ドキュメント
目的: 洗練された、公開可能なコンテンツを書く。これがWebサイトになります。
ここに含めるもの:
- 完全で、よく書かれたドキュメント
- 本番環境対応のコンテンツ
- 公開したいすべてのもの
例: 4.publish📚/documentation-guide.md
# ドキュメントのベストプラクティス
優れたドキュメントは、有用な製品と放棄された製品の違いです。
このガイドでは、優れたドキュメントを提供するチームから実証された
プラクティスをカバーします。
## なぜドキュメントが重要なのか
ユーザーは理解できないものを使用できません。最高のコードでさえ、
明確なドキュメントがなければ無用です...
[完全で洗練されたコンテンツが続きます...]ガイドライン:
- 完全な文章を書く
- コードサンプルを追加
- 画像/図を含める
- すべてのリンクをテスト
- 慎重に校正
特別な機能:
- ここのファイルがWebサイトのページになります
- Obsidian Wikiリンクをサポート:
[[page]] - Markdownリンクをサポート:
[page](./page.md) - Mermaid図が自動的に動作
archive🗑️ - 未使用の素材
目的: 採用されなかったコンテンツを保存する。
ここに含めるもの:
- 古い下書き
- 却下されたアイデア
- 置き換えられたコンテンツ
- 行き詰まったリサーチ
例: archive🗑️/old-architecture-design.md
ガイドライン:
- 削除せず、アーカイブ
- アーカイブした日付を追加
- アーカイブの理由を追加
- 後で復活できる
例: 完全なワークフロー
新機能「リアルタイムコラボレーション」を文書化してみましょう：
ステップ1: プロンプト
0.prompt🤖/feature-documentation-template.md
新機能を文書化：
- どんな問題を解決するか？
- ユーザーはどのようにアクセスするか？
- ステップバイステップガイド
- エッジケースとトラブルシューティングステップ2: ソース
1.source📦/realtime-collab-spec.md
# リアルタイムコラボレーション仕様
[エンジニアリングドキュメントからコピー&ペースト]
技術詳細：
- WebSocket接続
- Operational Transformアルゴリズム
- 競合解決...ステップ3: サンプリング
2.sampling✂️/realtime-collab-key-points.md
## ユーザー向け機能
- 他の人のカーソルを見る
- ライブテキスト更新
- 自動競合解決
## セットアップ要件
- 安定したインターネット
- WebSocketサポート
- 最新のブラウザステップ4: プロット
3.plot📋/realtime-collab-doc-outline.md
# リアルタイムコラボレーションガイド
1. はじめに - リアルタイム編集の理由
2. はじめに - 機能を有効化
3. コラボレーションの使用 - 他の人の編集を見る
4. トラブルシューティング - 接続の問題ステップ5: パブリッシュ
4.publish📚/realtime-collaboration.md
# リ���ルタイムコラボレーション
ドキュメントをリアルタイムで一緒に編集...
[完全で洗練されたガイド]成功のためのヒント
緩く始めて、厳密に終わる
- 初期段階：ラフなノートでOK
- 後期段階：洗練度が増す
- 1.source📦で過度に編集しない
各ステージでClaude Codeを使用
- 0.prompt: 「Xについてのインタビュー質問を生成」
- 1.source: 「この文字起こしを要約」
- 2.sampling: 「最も重要な5つのポイントを抽出」
- 3.plot: 「初心者向けガイドのアウトラインを作成」
- 4.publish: 「洗練された導入セクションを書く」
ステージ間のリンク
以前の作業を参照：
<!-- 3.plot📋/guide-outline.md内 -->
[[../2.sampling✂️/user-interviews.md]]の洞察に基づくステージをスキップしない
各ステージは前のステージの上に構築されます：
- 4.publishに早すぎるスキップ = 書き手のブロック
- 適切なサンプリングとプロット = 最終的な書き込みが容易