AIGNE DocSmith アップデート：よりスマートなドキュメント作成を、より少ない労力で
AIGNE DocSmith 0.9.0 のリリースを発表できることを嬉しく思います。これは、これまでで最大のベータリリースとなります。今回のリリースでは、ドキュメントの作成と保守をより簡単、迅速、かつコスト効率よく行うための新機能と改善の追加に重点を置きました。フィードバックを共有して、DocSmith の未来を共に形作っていきましょう。
新機能
API ドキュメント作成をシンプルに
OpenAPI 仕様から直接、完全な API ドキュメントを生成できるようになりました。OpenAPI 仕様の URL を設定に追加し、aigne doc generate を実行するだけで、エンドポイント、パラメータ、例などを含む包括的な API ドキュメントを取得できます。
sourcePaths:
- https://api.example.com/openapi.jsonこれにより、手動での API ドキュメント作成作業を大幅に削減できます。
推論エフォートによるコスト管理
新しい推論エフォート（Reasoning effort）制御により、品質とコスト、スピードのバランスを調整できるようになりました。素早いドラフト作成には「low」（高速で安価）に、本番用ドキュメントには「high」（高品質、より多くのトークンを使用）に設定します。
thinking:
effort: low # minimal, low, medium, high
迅速な反復作業には low を使用し、チームが信頼するドキュメントを公開する際には high を使用してください。
ダイアグラムの制御
ダイアグラムが多すぎるとドキュメントが煩雑になることがあります。そこで、0〜10 のスケールでダイアグラムの数を正確に設定できるようになりました。0 はダイアグラムなし、10 は最大限の視覚的ドキュメントを意味します。
diagramming:
effort: 5 # 0-10 scale, 0 = no diagrams, 10 = maximumドキュメントの整理
新しい aigne doc clear コマンドを使用すると、不要になったドキュメントを選択的に削除できます。ドキュメントセットを常に整理された状態に保つことができます。
自動的に開く評価レポート
aigne doc evaluate を実行した後、品質レポートがブラウザで自動的に開くようになりました。これにより、より迅速なフィードバックと改善が可能になります。
AI の理解力の向上
AI ファイルシステム統合
新しい AI ファイルシステムにより、AI エージェントがコードベースをより正確に理解できるようになりました。これにより、以下のメリットが得られます。
- ドキュメント内のコード例の精度向上
- 大規模プロジェクト全体にわたるコンテキスト認識の向上
- 大規模プロジェクトや複雑なコードベースにおけるドキュメント品質の改善
よりスマートなメディア処理
AI がドキュメント内の画像を分析し、説明文を作成できるようになりました。ソースパスに画像を含めると、AI が意味のある説明を生成します。
sourcePaths:
- ./assets/images/**/*.{png,jpg}パフォーマンスの向上
今回のリリースによる実環境での指標は、大幅な改善を示しています。
- 意図分析によるターゲットを絞った更新で、70% のトークンを節約
- 共有コンテキストによる構造プランニングが 30% 高速化
- スマートな生成により、不要なダイアグラムを 85% 削減
- 翻訳精度が 40% 向上
- 公開エラーが 60% 減少
修正点
このリリースには、ドキュメントの生成、翻訳、公開、およびファイル操作にわたる 40 以上の修正が含まれています。主な更新内容は以下の通りです。
- すべての更新操作において翻訳が正しく機能するようになりました
- 翻訳中にコードブロックが維持されるようになりました
- 公開されたドキュメントで画像が適切に表示されるようになりました
- ネストされた git リポジトリのパス処理を改善しました
- 公開時の認証フローを改善しました
公開体験の向上
パブリッシング（公開）がよりスムーズになりました。
- 短く共有可能な認証 URL
- 問題発生時のエラーメッセージの改善
- セッションの自動検証
- トークンリフレッシュ処理の向上
公開時にオプションでブランディングを更新することも可能です。
aigne doc publish --with-brandingはじめに
新規ユーザー
npm install -g @aigne/cli@latest
aigne doc init
aigne doc create既存ユーザー
最新バージョンにアップデートしてください。
npm install -g @aigne/cli@latest
aigne doc upgradeaigne.yml にオプションの新しい設定フィールドを追加できます。
thinking:
effort: low
diagramming:
effort: 5破壊的な変更はありません。既存の設定はすべて以前と同様に動作します。
内部的な改良
プロンプトの改善
強化されたプロンプトにより、より優れた構造を持つ表現力豊かなドキュメントが生成されます。XML タグの使用を標準化し、フォーマットガイドラインを改善しました。
トークンの最適化
複数の改善によりトークン使用量を削減しました。
- ターゲットを絞った更新のための意図分析
- 大規模なコードベースのためのチャンク処理
- スマートなコンテキスト共有
- 変更されたコンテンツのみの選択的再生成
今後の予定
現在、以下の機能に取り組んでいます。
- 生成されたドキュメント内での高度な検索
- カスタムコンポーネントテンプレート
- より多くのドキュメントプラットフォームとの統合
- 多言語サポートの強化
リソース
v1.0 の構築に協力する
私たちは現在ベータ版であり、フィードバックに基づいて積極的に DocSmith を改良しています。バグを見つけましたか？機能のアイデアがありますか？新しいドキュメントを必要としているコミュニティをご存知ですか？コミュニティでフィードバックを共有し、理想のドキュメントツールの構築をサポートしてください。
今すぐ試す
AIGNE DocSmith 0.9.0 は、ドキュメント生成をよりスマートに、そしてよりコスト効率よくします。API、コードベース、あるいはプロジェクト全体のドキュメントを作成する場合でも、今回のリリースには作業をより速く、より良く進めるためのツールが揃っています。
今すぐアップデートして、その違いを実感してください。
npm install -g @aigne/cli@latest