ブログ

音声コーディング: ドキュメンテーションとコメントを話して書く

音声コーディングの神話

開発者が「音声コーディング」聞くとき、ほとんどの人が誰かが大声でPython構文指示想像: 「defスペース計算アンダースコア合計openパリparen itemsクローズパリcolon...」それは音声コーディングではありません。それは拷問。

本当の音声コーディング構文入力置換ではありません。自然言語が大部分の計算開発を使用することです: ドキュメンテーション、コメント、コミットメッセージ、PR説明、タスク分解、Slackアップデート、コードレビュー。

自然言語の比率は構文でほとんどの開発作業での合計より高いより多くの開発者が認識します。徹底的な開発者は費やす事があります:

  • 20%コードを書く
  • ドキュメンテーションとコメント30%を書く
  • 15%は問題説明とPRコンテンツを書く
  • 20%Slack、メール、会議にある
  • 15%コードレビューと計画

それは音声入力をするタイプまたは同等に効果的な80%の仕事です。20%が実際の構文は、キーボード上に留まります。

開発者として何を指示するのか

コードコメント

コメントは純粋な自然言語。なぜ関数存在するか、どのエッジケースを処理するか、または呼び出し元が知るべきことは何かを説明する明確なコメントを書くことは、タイプするより話す方が簡単。

ワークフロー: エディタのコメント場所にナビゲート、ホットキーを押し、説明を話す、放す。クリーンモードはフィラーを削除し、クリーンな散文生成。

例: ホットキーを押し、「この関数はユーザートークンが期限切れであるが更新トークンがまだ有効なエッジケースを処理し、1回の更新をしようと試み、その後ログアウト再度失敗する場合、呼び出し元が認証エラーを処理するべき」を話し、放す。コメントが表示される、クリーンでフォーマット。

ドキュメンテーションとREADME

README ファイル、APIドキュメンテーション、インラインJSDocコメント/docstringコメント は全く音声入力が優れている場所。あなたは人間の読者のために自然な散文で書いています。同じことはコードを見ながら言い、それをタイプする摩擦。

関数ドキュメンテーションを話す一方でコード見る、より良いドキュメンテーション生成。自然に見ると説明し、キーストロークへの思考翻訳摩擦なし。

コミットメッセージ

良いコミットメッセージは短い散文: 何がカードのなぜ。コミットメッセージを話すのはタイプされ、クリーンモードはうまく読むこと確認。

プルリクエスト説明

PR説明 - 問題、解決、テストプラン、レビュアーノート - は Telvrの充実モードがうまく処理する構造化コンテンツです。開発タスクモードはこの構造を本来生成。

例: ホットキーを押し、開発タスクモードに切り替え、「支払い処理フローにレース条件固定、問題は2つの並行リクエストは両方残高確認でき、どちらか差引く前、トランザクション周辺にデータベースレベルの行ロック追加、2つの並行支払い試み生成テスト追加」を話し、放す。結果は問題、解決、テストノート付きの構造化されたPR説明。

問題とチケット説明

詳細なバグレポートまたは機能仕様をタイピング退屈。問題見ながら自然に話す、より速く、しばしば、より徹底説明生成。タイプ機械的なオーバーヘッド闘争しないから。

Slackとチームの更新

進度更新、ブロッカー、スタンドアップサマリー - これらは本質的に会話です。「昨日認証リファクター完了、今日支払い統合を取り組むが、サンドボックス環境のため試験認証を得るのにブロック、サラに頼むつもり。」完全スタンドアップ15秒音声で。

開発者ワークフロー設定

ホットキー構成

デフォルトTelvrホットキー(Macでオプション+スペース)開発者のため十分な機能、ほとんどのIDEショートカットと競合。別のものを好む場合、ホットキー設定可能。

開発者向けセットアップ推奨:

  • ホームロー上の指を保つ
  • 端末内のアクシデント活性化を回避するために2キー組合使用
  • IDE(VS CodeまたはJetBrains keymaps確認)と競合するホットキー回避

モード選択

開発ワークフロー:

  • クリーンモード: 一般的なコメント、散文ドキュメンテーション、Slackメッセージ
  • 開発タスクモード: PR説明、問題仕様、技術要件サマリー
  • 会議ノートモード: スプリント後ノート、設計議論サマリー
  • メールモード: クライアント対面技術通信、ステークホルダーへのアップデート

IDE統合

Telvrはシステム全体テキスト挿入を使用し、あらゆるテキストフィールドで機能することを意味します:

  • VS Code(コードエディタ、統合ターミナル、検索、コメント)
  • JetBrains IDE(IntelliJ、WebStorm、PyCharm)
  • Zed、Neovim(入力モード時)
  • Linear、Jira、GitHub(ブラウザで)
  • ターミナル(git commitメッセージのような非コマンドテキスト入力)

インストール済みプラグインなし。任意のテキストフィールドは公正ゲーム。

実際の開発者ワークフロー

ここは開発セッション音声入力とどのように見えるか:

朝スタンドアップSlack: ホットキーを押し、昨日進度+今日計画+ブロッカー話、放す。20秒で完了。

コーディング: キーボード。通常の開発ワークフロー。

複雑な関数へのコメント追加: 正しい行にナビゲート、ホットキーを押し、説明を自然に話す、放す。

GitHubの問題でバグ作成: 新しい問題を開く、開発タスクモードでホットキー、バグと再現ステップ説明、放す。問題タイトル、スポット。

コミットメッセージ書く: git commitをターミナルで、エディタ(またはファイルへのパイプ)で開くホットキーを押し、コミット説明を話す、放す。

PR説明を書く: PR フォーム開く、開発タスクモードでホットキーを押し、PRが何をしてなぜか説明、放す。必要であればレビュアーノート追加。

Slackで技術的な質問に回答: ホットキーを押し、技術的な決定またはコンセプトを大声で説明、放す。クリーンモードはタイプ慎重に必要なく理解可能な説明生成。

生産性の現実

開発者ワークフローでの音声入力からの最大ゲイン生のスピード、むしろ摩擦削減から来る。ドキュメンテーションはしばしば延期されるか、タイプスキップ感じ形容詞仕事の上のオーバーヘッドの。書き込みコメントまたはdocstring2分の慎重なタイピング、代わり15秒音声がドキュメント追加の閾値を大幅に削減。

より良いドキュメント化されたコード、より完全なPR説明、より徹底したイシュー報告は、開発者音声入力の実用的な成果多くの場合。唯一の同じ習慣より速い実行ではなく。

1週で新しい習慣

音声入力を開発ワークフロー:

1日: Slack メッセージのみで音声を使用。いかなるもの。

3日: コミットメッセージを追加。ターミナルエディタに説明を指示。

5日: インラインコメント追加。複雑な関数完了として始まる。

7日: 開発タスクモード使用してPR説明追加。以前のタイプより、より完全な説明を書く注意。タイピングより高速だから。

2週の後、習慣確立され、音声入力自然に、努力のではなく見える。