mcpField
W
workspace-documentation

workspace-documentation

github.com/qodex-ai生産性47139 回インストール42 週間前に更新
リポジトリ

workspace-documentation について

workspace-documentationは、会話や知見をNotionワークスペースの構造化ドキュメントに変換するスキルです。内容の種類と保存先を整理し、新しいページをリンクして見つけやすくします。

主な機能

  1. 01会話から知識を抽出
  2. 02文書の種類に応じて内容を整理
  3. 03Notion検索で保存先を特定
  4. 04Notionにページを作成
  5. 05ページをワークスペースのナビゲーションに追加

活用シーン

  1. 01会議の議論を文書として保存
  2. 02決定ログに判断を記録
  3. 03質疑応答をFAQ項目に整理
  4. 04Notionでプロジェクトの知識を整理

MCP 対応

保存先の検索とページ作成に、notion-searchやnotion-create-pagesなどのNotionツールを使用します。新しい内容は関連するワークスペースのページやデータベースにもリンクします。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/qodex-ai/ai-agent-skills --skill workspace-documentation

インストール後、Claude Code で/workspace-documentationを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

evaluations/
conversation-to-wiki.json
decision-record.json
README.md
examples/
conversation-to-faq.md
decision-capture.md
how-to-guide.md
reference/
database-best-practices.md
decision-log-database.md
documentation-database.md
faq-database.md
how-to-guide-database.md
learning-database.md
team-wiki-database.md

詳細

ナレッジの記録

会話、議論、知見を、Notion ワークスペース内の構造化されたドキュメントに変換します。チャットのコンテキストから知識を取り込み、適切な形式に整え、整理とリンクを適切に行ったうえで正しい場所に保存します。

クイックスタート

Notion に情報を保存するよう依頼された場合:

  1. 内容を抽出する:会話のコンテキストから重要な情報を特定します
  2. 情報を構成する:適切なドキュメント形式に整理します
  3. 保存先を決定する:Notion:notion-search を使い、適切な Wiki ページまたはデータベースを探します
  4. ページを作成する:Notion:notion-create-pages を使って内容を保存します
  5. 見つけやすくする:関連するハブページからリンクしたり、データベースに追加したり、Wiki のナビゲーションを更新したりして、ほかの人が見つけられるようにします

ナレッジ記録のワークフロー

ステップ 1:記録する内容を特定する
From conversation context, extract:
- Key concepts and definitions
- Decisions made and rationale
- How-to information and procedures
- Important insights or learnings
- Q&A pairs
- Examples and use cases
ステップ 2:内容の種類を決定する
Classify the knowledge:
- Concept/Definition
- How-to Guide
- Decision Record
- FAQ Entry
- Meeting Summary
- Learning/Post-mortem
- Reference Documentation
ステップ 3:内容を構成する
Format appropriately based on content type:
- Use templates for consistency
- Add clear headings and sections
- Include examples where helpful
- Add relevant metadata
- Link to related pages
ステップ 4:保存先を決定する
Where to save:
- Wiki page (general knowledge base)
- Specific project page (project-specific knowledge)
- Documentation database (structured docs)
- FAQ database (questions and answers)
- Decision log (architecture/product decisions)
- Team wiki (team-specific knowledge)
ステップ 5:ページを作成する
Use Notion:notion-create-pages:
- Set appropriate title
- Use structured content from template
- Set properties if in database
- Add tags/categories
- Link to related pages
ステップ 6:内容を見つけやすくする
Link the new page so others can find it:

1. Update hub/index pages:
   - Add link to wiki table of contents page
   - Add link from relevant project page
   - Add link from category/topic page (e.g., "Engineering Docs")

2. If page is in a database:
   - Set appropriate tags/categories
   - Set status (e.g., "Published")
   - Add to relevant views

3. Optionally update parent page:
   - If saved under a project, add to project's "Documentation" section
   - If in team wiki, ensure it's linked from team homepage

Example:
Notion:notion-update-page
page_id: "team-wiki-homepage-id"
command: "insert_content_after"
selection_with_ellipsis: "## How-To Guides..."
new_str: "- <mention-page url='...'>How to Deploy to Production</mention-page>"

このステップにより、知識が「孤立」せず、ワークスペースのナビゲーション構造に適切に結び付けられます。

内容の種類

内容に応じて適切な構成を選びます:

概念:概要 → 定義 → 特徴 → 例 → ユースケース → 関連情報
ハウツー:概要 → 前提条件 → 手順(番号付き)→ 検証 → トラブルシューティング → 関連情報
意思決定:背景 → 決定事項 → 根拠 → 検討した選択肢 → 結果 → 実装
FAQ:簡潔な回答 → 詳細な説明 → 例 → 使用する場面 → 関連する質問
学び:何が起きたか → うまくいったこと → うまくいかなかったこと → 根本原因 → 学び → 対応策

保存先のパターン

一般的な Wiki:独立したページ → インデックスに追加 → タグ付け → 関連ページからリンク

プロジェクト Wiki:プロジェクトページの子ページ → プロジェクト概要からリンク → プロジェクト名でタグ付け

ドキュメントデータベース:プロパティを使用します(タイトル、種類、カテゴリ、タグ、最終更新日、担当者)

意思決定ログデータベース:プロパティを使用します(決定事項、日付、ステータス、領域、決定者、影響)

FAQ データベース:プロパティを使用します(質問、カテゴリ、タグ、最終レビュー日、有用度カウント)

データベースの選択ガイドと個別のスキーマファイルについては、reference/database-best-practices.md を参照してください。

会話からの内容の抽出

チャットでの議論:重要なポイント、結論、リソース、アクションアイテム、質疑応答

問題解決:問題の説明、試したアプローチ、解決策、うまくいった理由、今後の検討事項

ナレッジ共有:説明した概念、例、ベストプラクティス、よくある落とし穴、リソース

意思決定の議論:質問、選択肢、トレードオフ、決定事項、根拠、次のステップ

書式設定のベストプラクティス

構成:#(タイトル)、##(セクション)、###(サブセクション)を一貫して使用します

文章:概要から始め、箇条書きを使い、段落を短く保ち、例を追加します

リンク:関連ページにリンクし、人に言及し、リソースを参照し、相互リンクを作成します

メタデータ:日付、作成者、タグ、ステータスを含めます

検索性:明確なタイトル、自然なキーワード、一般的な検索タグ、画像の代替テキストを使用します

インデックス作成と整理

Wiki インデックス:ページへのリンクを付けて、「はじめに」「ハウツーガイド」「リファレンス」「FAQ」「意思決定」などのセクションごとに整理します

カテゴリページ:概要、ドキュメントへのリンク、最近の更新情報を含むランディングページを作成します

タグ付け戦略:テクノロジー/ツール、トピック、対象者、ステータスに一貫性のあるタグを使用します

更新管理

新規作成:内容に実質的な情報がある(2 段落を超える)、複数回参照される、ナレッジベースの一部である、または独立して見つけられる必要がある場合

既存ページを更新:既存のトピックに内容を追加する場合、情報を修正する場合、概念を拡充する場合、または変更に合わせて更新する場合

バージョン管理:重要な変更については、更新履歴のセクション(日付、作成者、変更内容、理由)を追加します

ベストプラクティス

  1. 速やかに記録する:内容を覚えているうちに文書化します
  2. 一貫した構成にする:類似した内容にはテンプレートを使用します
  3. 幅広くリンクする:関連するナレッジをつなげます
  4. 見つけやすくする:検索しやすいタイトルとタグを使用します
  5. 背景を含める:なぜ重要なのか、いつ使うのかを記載します
  6. 例を追加する:具体例は理解の助けになります
  7. メンテナンスする:定期的に見直して更新します
  8. フィードバックを得る:ドキュメントが役立つか確認します

高度な機能

ドキュメントデータベース:データベーススキーマのパターンについては、reference/database-best-practices.md を参照してください。

よくある問題

「どこに保存すればよいかわからない」:まずは一般的な Wiki に保存し、後から移動できます 「内容が断片的」:関連する断片をまとめて、一貫性のあるドキュメントにします 「すでに存在する」:まず検索し、適切であれば既存のものを更新します 「くだけすぎている」:要点を保ちながら表現を整えます

例

一連のワークフローについては、examples/ を参照してください。

コメント