ワークスペースのルールとメモリを活用して、Windsurf をスタイルガイドやコンポーネント、プロジェクトの文脈を理解するドキュメントのエキスパートに変えましょう。

​
Mintlify で Windsurf を使う

Windsurf の Cascade AI アシスタントは、Mintlify のコンポーネントを使って、あなたの基準に沿ったドキュメントを作成するように調整できます。ワークスペースルールとメモリはプロジェクトに関する永続的なコンテキストを提供し、Cascade の提案をより一貫させます。
  • ワークスペースルール はドキュメント用リポジトリに保存され、チームで共有されます。
  • メモリ は時間とともに蓄積される個人単位のコンテキストを提供します。
共有のドキュメント標準を確立するために、ワークスペースルールの設定を推奨します。作業しながらメモリを育てることはできますが、共有されないため、チームメンバー間で一貫性は保たれません。 ドキュメントリポジトリの .windsurf/rules ディレクトリにワークスペースルールを作成してください。詳細は Windsurf のドキュメントの Memories & Rules を参照してください。

​
ワークスペースルールの例

このルールは、Mintlify のコンポーネントと一般的なテクニカルライティングのベストプラクティスに関するコンテキストを Cascade に提供します。 このルールはそのまま使うことも、ドキュメントに合わせてカスタマイズすることもできます。
  • 執筆基準: スタイルガイドに合わせて言語ガイドラインを更新します。
  • コンポーネントのパターン: プロジェクト固有のコンポーネントを追加するか、既存の例を調整します。
  • コード例: 製品の実際の API 呼び出しとレスポンスで汎用例を置き換えます。
  • 文体とトーンの好み: 用語、書式、その他のルールを調整します。
ルールは、ドキュメントのリポジトリ内の .windsurf/rules ディレクトリに .md ファイルとして保存します。 
# Mintlify technical writing rule

## Project context

- これは Mintlify プラットフォーム上のドキュメントプロジェクトです
- MDX ファイルに YAML フロントマターを使用します  
- ナビゲーションは `docs.json` で設定します
- テクニカルライティングのベストプラクティスに従います

## Writing standards

- 手順の説明は二人称（"you"）を使います
- 能動態・現在形で記述します
- 手順は前提条件から始めます
- 主要なステップには期待される結果を含めます
- 説明的でキーワードを含む見出しを使います
- 文は簡潔かつ情報量を保ちます

## Required page structure

すべてのページはフロントマターから開始します:

```yaml
---
title: "明確で具体的なタイトル"
description: "SEO とナビゲーションのための簡潔な説明"
---
```

## Mintlify components

### docs.json

- docs.json ファイルとサイトのナビゲーションを作成する際は、[docs.json のスキーマ](https://mintlify.com/docs.json)を参照してください

### Callouts

- 役に立つ補足情報には `<Note>`
- 重要な注意点や互換性破壊の変更には `<Warning>`
- ベストプラクティスや専門的なアドバイスには `<Tip>`  
- 中立的な背景情報には `<Info>`
- 成功の確認には `<Check>`

### Code examples

- 適宜、完全で実行可能な例を含めます
- 複数言語の例には `<CodeGroup>` を使用します
- すべてのコードブロックに言語タグを指定します
- プレースホルダーではなく現実的なデータを使用します
- API ドキュメントには `<RequestExample>` と `<ResponseExample>` を使用します

### Procedures

- 連続した手順には `<Steps>` コンポーネントを使用します
- 適宜 `<Check>` コンポーネントで検証ステップを含めます
- 複雑な手順は小さなステップに分割します

### Content organization

- プラットフォーム別の内容には `<Tabs>` を使用します
- 段階的な開示には `<Accordion>` を使用します
- 強調したいコンテンツには `<Card>` と `<CardGroup>` を使用します
- 画像は説明的な代替テキストとともに `<Frame>` コンポーネントで囲みます

## API documentation requirements

- すべてのパラメータは `<ParamField>` で記載します
- レスポンス構造は `<ResponseField>` で示します
- 成功例とエラー例の両方を含めます
- 入れ子のオブジェクトのプロパティには `<Expandable>` を使用します
- 認証の例は必ず含めます

## Quality standards

- 公開前にすべてのコード例をテストします
- 内部リンクには相対パスを使用します
- すべての画像に代替テキストを含めます
- 見出しの階層が適切か確認します（h2 から開始）
- 既存のパターンとの一貫性を確認します

​
Cascade の活用

ルールを設定したら、Cascade を使ってさまざまなドキュメント作成タスクを効率化できます。詳細は、Windsurf ドキュメントの Cascade を参照してください。

​
例のプロンプト

新規コンテンツの作成: 
自社APIの認証方法を解説する新しいページを作成してください。JavaScript、Python、cURLのコード例を含めてください。
既存コンテンツの改善: 
このページを確認し、分かりやすさとコンポーネントの活用に関する改善案を提案してください。手順をより追いやすくすることに重点を置いてください。
コード例の作成: 
このAPIエンドポイントのエラーハンドリングを示す、完結したコード例を生成してください。現実的なデータを用い、期待されるレスポンスも含めてください。
一貫性の維持: 
この新しいページがドキュメントの標準に準拠しているか確認し、必要な修正案を提案してください。