問題
開発者はほとんどの人が実現するより多くのテキストを作成しています。コード自体を超えて、VS Code内で起こる継続的な非コード書き込みのストリームがあります:インラインコメント、関数docstrings、READMEセクション、コミットメッセージドラフト、チケット説明、todoアノテーション、アーキテクチャ決定メモ。
この書き込みは、しばしば二次として扱われます — 何か迅速に行うか、後で延期します。結果は、希薄なドキュメント、説明のない関数、アーキテクチャの決定がかつて誰かのメモリのみに存在するコードベースです。
摩擦は実在します。複雑なアルゴリズムに精神エネルギーを費やした後、最後のことはほとんどの開発者がそれを説明する段落を書きたいと思っています。タイピングは実際の仕事の上の追加の仕事のように感じます。しかし、実装直後に作成されたドキュメント — コンテキストが新鮮な間に — は、1週間後、または決して作成されたドキュメントよりも劇的に価値があります。
TelvrがVS Codeでどのように動作するか
Telvrはシステムレベルのカーソル位置注入を通じてVS Code および他のテキストエディタと統合します。VS Code拡張は必要ありません。エディタのAPIキー。VS Code内の構成がありません。
開発ドキュメントのワークフロー:
- VS Codeを開き、ドキュメントが表示される場所にカーソルを配置します — 関数の上、コメントブロック内、READMEファイル内、または新しいマークダウンドキュメント内。
- Telvrホットキーを押します。
- ドキュメンテーション、説明、またはタスク説明を話します。
- ホットキーをリリースします。フォーマットされた出力は2秒以下でカーソルに表示されます。
- コードを続行します。
Telvrはすべてのvs Code コンテキスト(エディタ自体、統合ターミナル、マークダウンプレビューファイル)で機能します。また、VS Code設定JSONおよびコメントを追加したい他の構成ファイルでも機能します。
VS Code用の最適なエンリッチメントモード:Dev Task
Dev Taskモードは開発ワークフロードキュメント用に特別に設計されました。それを有効にしてコードまたはタスクについて話すと、AIは開発準備完了形式で出力を4つのセクションに構造化します:
コンテキスト:このコードが何をするか、なぜ存在するか、またはそれが解決される問題を説明する背景情報。
要件:実装が満たす必要があるもの — 制約、依存関係、エッジケース、またはビジネスルール。
実装メモ:技術的詳細、採択されたアプローチ、トレードオフが検討された、または重要な警告。
受け入れ基準:実装が正しいことを確認する方法 — パスすべきテスト、予想される動作、または成功を定義する条件。
この構造は以下に直ちに有用です:
- 複雑なロジックを説明する関数レベルドキュメンテーションブロック
- 明白でないモジュールのファイルレベルヘッダーコメント
- コードファイル直接でタスク説明を計画するとき
- マークダウンで起草されたアーキテクチャ決定レコード(ADR)
simpler インラインコメント — 正規表現のクイック説明、既知の制限についてのメモ — クリーン&修正モードは正式な構造なしでクリーン、読みやすい散文を提供します。
前後の例
生スピーチ入力(Dev Taskモード):
「um、この関数はAPI用のレート制限を処理しており、ユーザーあたりのリクエストを分あたり分あたりトラックする必要があります。それは固定ウィンドウではなくスライディングウィンドウを使用する必要があります。固定ウィンドウは境界の右で交通を爆発させることができるため、um。Redisカウンタストレージに依存し、制限を超過すると429でretry-afterヘッダーを返すべきです。Redisを長期間満たさないようにRedis上の制限キーが自動的に期限切れになるようにすることも確認する必要があります。」
Dev Taskモード後:
コンテキスト ユーザーあたりのAPI速度制限を処理し、スライディングウィンドウアルゴリズムを使用します。複数インスタンス展開をサポートするために分散カウンタストレージ用のRedisを使用します。
要件
- スライディングウィンドウ(固定ウィンドウではなく)を使用してユーザーあたりのリクエストをリクエスト追跡する
- 制限を超過したときに
Retry-Afterヘッダーで HTTP 429 を返す- Redisキーは自動的に期限切れになる必要があります。バウンドレス保存の成長を防ぐため
実装メモ
- スライディングウィンドウウィンドウ境界で交通を爆発させるために固定ウィンドウ上で選択
- 分散レート制限状態のためのRedis依存
受け入れ基準
- 速度制限は持続的で爆発交通パターンで正しく実行されます
- Redisキーは予想通りに期限切れになります(TTLコマンドで確認)
- 429レスポンスは有効な
Retry-Afterヘッダーを含めます- 拡張テスト期間後にRedisキー蓄積なし
スポークンバージョンはぶつぶつ言う説明です。Dev Task出力は関数の上にドキュメンテーションブロックとして直接貼り付けることができる構造化仕様です。
時間節約
ドキュメンテーションは、その認識値の相対的にタイプするスローさのため、慢性的にunderprioritizeされています。音声ドキュメンテーションに切り替わる開発者は、2つの変更を報告:彼らはより文書化、彼らはより良いドキュメント化。
徹底的な関数ドキュメンテーションブロックを書くのに5~8分の焦点タイピングがかかります。同じコンテンツを話すのに60~90秒かかり、Dev Taskモードはフォーマットを処理します。削減されたタイムを投資するため、ドキュメンテーション負担からは実行可能に見えます。
より長いドキュメント — README、アーキテクチャ決定レコード、オンボーディングガイド — のために、時間節約はグループ分けによって等しく拡大しています。1,000ワードREADMEは45分を書くのに時間がかかる場合、10~12分で転記でき、その後編集できます。
また、品質の議論があります。コードを作成した直後にドキュメンテーションが起草されると、実装詳細が新鮮なため、その結果のドキュメンテーションはより正確で有用です。Telvrの速度は、コード化しながらドキュメント化を実行しやすくしてから、延期タスクとしては。
定期的なドキュメント作業を持つ典型的な開発週を通じて、Telvrは2~3時間を回復できます — そして副作用として、より徹底的に文書化されたコードベースを生産します。
始める
- telvr.aiからmacOS用Telvrをダウンロードします。
- セットアップを完了し、優先マイクを構成します。
- VS Code ワークフロー内で機能するホットキーを設定します — ホームローから手を遠く移動することなく圧力をかけることができるもの。
- VS Codeを開き、関数またはドキュメンテーションブロックの上にカーソルを配置し、最初の転記をお試しください。
- 開発ドキュメント作業のデフォルトモードとしてDev Taskを設定します。
良い最初の演習:現在のプロジェクトで3番目のほとんどの複雑な関数を見つけます — クリアドキュメンテーションから最も利益を得るもの — そして各DEV Taskブロックを転記します。全体の演習は10分未満かかり、ドキュメンテーションを生成し、それは書くのに1時間がかかります。
Telvrはすべてのエンリッチメントモードへのフルアクセス付きの14日間の無料トライアルを含みます。トライアル後、価格設定は月EUR3 + 転記分EUR0.03です。