[ contents ]
はじめに

Rasen ドキュメント

ようこそ。これは rasen のすべての家です。

Rasen はあなたと AI コーディング アシスタントがコードが書かれる前に構築内容に同意するのを支援します。変更を説明し、AI は短い仕様とタスク リストを下書きし、両方が同じプランを見て、その後作業が起こります。AI が間違ったものを構築したことを途中で発見することはもうありません。

他に何も読まない場合、これら 2 つのページを読んでください:

  1. はじめに: インストール、初期化、最初の変更をシップします。
  2. コマンドがどのように機能するか: 実際に /rasen:propose を入力する場所(ヒント: 端末ではなく AI チャットで)。これはほぼすべての人を一度トリップします。

その 2 番目のものは見た目以上に重要です。Rasen には 2 つの半分があります: 端末で実行する コマンド ライン ツール、および AI アシスタントに与えるスラッシュ コマンド。どちらがどちらかを知ることで、最も一般的な混乱の瞬間を節約できます。

最初に構築する最良の習慣: 構築内容が確実でない場合は、/rasen:explore で開始します。 これはコードを読み、オプションを検討し、成果物またはコードが存在する前にぼやけたアイデアを具体的なプランに研ぎます、ステークスなし思考パートナー。Explore First ガイドはケースを作成します。

パスを選択

初めてです。 はじめに で開始してから、一目でわかるコア概念 をスキムしてください。何か不可思議に感じたら、FAQ用語集 が近くにあります。

問題がありますが計画がありません。 これが一般的なケースで、専用の回答があります: Explore First。何かをコミットする前に、AI と一緒に考えるために /rasen:explore を使用してください。

大きな既存のコードベースがあります。 すべてをドキュメント化する必要はありません。既存プロジェクトで Rasen を使用 は海を沸騰させることなく、実際のブラウンフィールド コードを開始する方法を示しています。

それが動作するようにしたいだけです。 インストールrasen init を実行し、最初のスラッシュ コマンドが正しい場所に着地するように コマンドがどのように機能するか を読んでください。

例で学びます。 例とレシピ ページは、実際の変更を開始から終了まで歩行します: 小さな機能、バグ修正、リファクター、探索。

AI がプランを下書きしました—次はどうですか? それを読んでください。変更のレビュー は、まだ安い間に間違った折り返しをキャッチする 2 分間のパスを示し、良い仕様の書き方 は承認する価値があるプランが何でできているかを対象にします。

チームで働きます。 チームの Rasen は、変更がどのようにブランチと プル リクエストにマップされるか、またはチームメイトがコードの前にプランをレビューする方法を示しています。

古いワークフローから来ています。 マイグレーション ガイド 変更内容と理由を説明し、既存の作業が安全であることを約束します。

チームのプロセスに曲げたいです。 カスタマイズ は、プロジェクト設定、カスタム スキーマ、および共有コンテキストを対象にします。

何か壊れています。 トラブルシューティング は、実際にヒットした失敗を修正で収集します。

全体マップ

ここから始める

ドキュメント それが与えるもの
はじめに インストール、初期化、最初の変更を終了まで実行
Explore First /rasen:explore を使用してコミットする前にアイデアを考えてください
コマンドがどのように機能するか スラッシュ コマンドが実行される場所、「インタラクティブ モード」が何を意味するか、端末対チャット
一目でわかるコア概念 1 つのページ上の全体的なメンタルモデル: 仕様、変更、デルタ、アーカイブ
インストール npm、pnpm、yarn、bun、Nix、および動作を検証する方法

毎日使用

ドキュメント それが与えるもの
ワークフロー 一般的なパターンおよび各コマンドに手を伸ばす時期
例とレシピ 実際の変更の完全なチュートリアル、コピー可能
良い仕様の書き方 強力な要件とシナリオがどのように見えるか、および変更のサイズ設定方法
変更のレビュー コードが書かれる前に下書きプランで 2 分間のパス
チームの Rasen 変更がブランチ、プル リクエスト、レビューにどのように適合するか
既存プロジェクトで Rasen を使用 大きなブラウンフィールド コードベースで rasen を採用
変更の編集と反復 成果物を更新、戻る、手動編集を調整
コマンド すべての /rasen:* スラッシュ コマンドのリファレンス
CLI すべての rasen 端末コマンドのリファレンス

深く理解

ドキュメント それが与えるもの
概念 仕様、変更、成果物、スキーマ、アーカイブの長いフォーム説明
OPSX ワークフロー ワークフローが フェーズロックではなく流動的である理由、プラス アーキテクチャ ディープ ダイブ
用語集 すべての用語が 1 つの場所で定義

あなた自身にする

ドキュメント それが与えるもの
カスタマイズ プロジェクト設定、カスタム スキーマ、共有コンテキスト
多言語 英語以外の言語で成果物を生成
サポート対象ツール rasen が統合する 25+ 個の AI ツール、およびファイルが着地する場所

ヘルプが必要なとき

ドキュメント それが与えるもの
FAQ 人々が最も多く尋ねる質問への迅速な回答
トラブルシューティング 具体的な失敗に対する具体的な修正
マイグレーション ガイド レガシー ワークフローから OPSX への移行

リポ全体での座標(ベータ)

ドキュメント それが与えるもの
ストア: ユーザー ガイド 作業がリポまたはチーム全体にまたがるとき、独自のリポで計画
エージェント契約 エージェント ドライブのマシン読み込み可能な CLI サーフェス

30 秒バージョン

1. インストール        npm install -g @atelierai/rasen@latest
2. 初期化            cd your-project && rasen init
3. 探索             (AI チャットで)  /rasen:explore           ← オプション、しかし素晴らしい習慣
4. 提案             (AI チャットで)  /rasen:propose add-dark-mode
5. 構築             (AI チャットで)  /rasen:apply
6. アーカイブ       (AI チャットで)  /rasen:archive

ステップ 1 と 2 は端末で発生します。残りは AI アシスタントのチャットで発生します。この分割は覚える価値のある 1 つのもので、コマンドがどのように機能するか はまさにその理由を説明しています。ステップ 3 はオプションですが、不確実な場合は /rasen:explore で開始することが最も価値のある習慣です。

ヘルプを得るための他の場所

  • Discord: discord.gg/YctCnvvshC 質問、アイデア、ヘルプ用。
  • GitHub Issues: github.com/DumoeDss/rasen/issues バグとフィーチャー リクエスト用。
  • rasen feedback "your message" フィードバックを端末から直接送信(GitHub イシューを開く)。

これらのドキュメントに間違い、古い、または混乱させるものが見つかりましたか?それはバグです。イシューまたは PR を開いてください。ドキュメント改善は、できる最も価値のある貢献の一部です。

Web サイト公開

パブリック rasen Web サイトは、このこれを公開します docs/ ツリーの多くの場所。このディレクトリの website-manifest.json がインターフェースです: 公開されるページ、セクション、順序、タイトル、スラッグを正確に宣言します。サイトに表示される必要があるドキュメントを追加または名前変更する場合は、マニフェストを一緒に更新してください—サイト ビルドはそれを直接読み、推測しません。