01
変更を検知
コードやAPIの差分を読み、ドキュメントに影響する変更を見つけます。
コードとドキュメントの同期
ドキュメントをコードより遅らせない。
影響を受けるドキュメントと更新理由を一か所で確認できます。
02
更新案を作成
関連ドキュメントをつなぎ、何をなぜ直すべきかを根拠とともに提案します。
03
確認して反映
人が更新案を確認し、承認した内容だけを最新ドキュメントに反映します。
開発ドキュメント
ずれやすいドキュメントから始めましょう。
既存のツールや開発フローを変えず、最新化が難しいドキュメントから接続できます。
API・開発ドキュメント
エンドポイント、リクエスト例、レスポンス項目をコードと同期します。
品質・認証ドキュメント
機能説明、試験根拠、要求トレースなど変更履歴が重要な文書に更新理由を残します。
リリース・運用ドキュメント
リリースごとに整理する変更点や運用案内をコードから準備します。
よくある質問
導入前に確認できます。
Specifyは何をしてくれますか？
コード変更を読み、影響を受ける開発ドキュメントを見つけて更新案を作ります。各提案には根拠が付き、人が確認してから反映できます。
ドキュメントは自動ですぐ変わりますか？
いいえ。Specifyはまず更新案を提案します。担当者が変更内容と根拠を確認し、承認した場合だけ反映されます。
どのドキュメントから始められますか？
APIリファレンス、開発ガイド、品質・認証文書、リリースノートなど、コードと一緒に変わる文書に適しています。
今の開発フローを変える必要がありますか？
ありません。既存のコードリポジトリとドキュメントフローを維持できます。パイロットでは一種類の文書から対象範囲と確認方法を決めます。
チームのドキュメントで試してみましょう。
ワークスペースですぐに試すか、現在の開発ドキュメントに合わせたパイロットを相談できます。
変更が多いドキュメントとコード領域を教えてください。