API文書の更新
エンドポイントのパラメータ、レスポンスのフィールド、リクエスト例をコードと照合し、修正案を確認します。
API文書更新ガイドコードの変更を読み取り、関連するドキュメントを見つけ、確認できる修正案まで準備します。
GitHubを接続して、開発文書の作成と更新にかかる繰り返し作業を減らしましょう。
クレジットカード不要 · 個人向け無料プランから
ユースケース
よく使う文書から接続し、コード変更と合わせて確認しましょう。
エンドポイントのパラメータ、レスポンスのフィールド、リクエスト例をコードと照合し、修正案を確認します。
API文書更新ガイドプロジェクト構造と実行方法の下書きを作成し、チームの判断背景とアクセス手順を補足します。
オンボーディング文書ガイドリポジトリの変更を文書につなぎ、修正案の根拠と反映範囲を確認します。
GitHub文書連携ガイドよくある質問
Specifyは小さな開発チームのための開発ドキュメント自動化ツールです。GitHubのコード変更を関連文書につなぎ、変更の根拠と修正案を確認できます。
GitHubリポジトリを文書プロジェクトのソースとして接続し、作成する文書を選びます。権限とソース範囲を確認し、生成文書を現在のコードと照合してください。その後の反映は設定と適用ポリシーに従います。
リクエスト、レスポンス、認証、エラー、使用例、互換性を確認します。変更の根拠と修正前後を実際のAPI動作と照合してください。設計意図や移行時期はチームによる補足が必要です。
コードと設定を根拠に、構造、実行方法、主要機能を説明する文書を準備します。権限申請先やコードにない判断背景は人が補い、初めて読む開発者がインストール・実行・テストを確認してください。
新しいプロジェクトは自動反映なしで開始します。変更内容と根拠を確認でき、その後の反映方法はプロジェクト設定と適用ポリシーに従います。自動反映が許可されている場合、低リスクの変更は自動承認されることがあります。
API仕様書、連携ガイド、アーキテクチャ設計記録(ADR)、オンボーディングガイド、リリースノートなど、コードとともに更新すべき技術文書に最適です。
ありません。既存のGitHubリポジトリやドキュメントツールをそのまま接続してご利用いただけます。
すべてのデータはAWSエンタープライズインフラでワークスペース単位に分離されます。AIモデルの学習にお客様のデータは一切使用しません。
GitHubリポジトリを接続し、分析するソースと作成する文書を選んで開始します。準備・処理時間はリポジトリの規模、接続状態、選択した文書によって異なります。まずはよく使う文書一つから確認してください。
個人向け無料プランはクレジットカードなしで開始できます。文書数は無制限で、100MBのストレージと基本AI利用枠が含まれます。個人のAI利用量を増やす場合はPro・Max、チームでの共同作業にはTeamをご確認ください。
GitHubリポジトリとチーム文書を接続し、最初の文書と修正案を確認してください。
クレジットカード不要 · 個人無料からチーム向けプランまで柔軟に対応