所有使用场景VS Code

VS Code语音编码:代码听写,无需手指

问题所在

开发者写的文本比大多数人意识到的要多。除了代码本身,在VS Code内部还有一个持续的非代码写作流:内联注释、函数文档字符串、README部分、提交消息草稿、票据描述、todo注释和架构决定笔记。

这种写作通常被视为次要的——快速做的事情,或者推迟到以后。结果是文档稀疏的代码库、没有解释为何存在的函数,以及仅存在于某人记忆中的架构决定。

摩擦力是真实的。在花费脑力在复杂算法上之后,大多数开发者最不想做的事就是写一段解释它的段落。输入感觉像是对实际工作的额外工作。但在实现后立即编写的文档——当背景仍然新鲜时——比一周后编写或根本不编写的文档有价值得多。

Telvr如何与VS Code配合使用

Telvr通过系统级游标位置注入与VS Code和任何其他文本编辑器集成。不需要VS Code扩展。编辑器中没有API密钥。VS Code本身中没有配置。

开发文档的工作流程:

  1. 打开VS Code并将光标放在您想要文档出现的位置——在函数上方、在注释块中、在README文件中或在新的markdown文档中。
  2. 按下您的Telvr热键。
  3. 讲述您的文档、解释或任务描述。
  4. 释放热键。格式化的输出在不到两秒钟的时间内出现在您的光标位置。
  5. 继续编码。

Telvr在所有VS Code背景中工作:编辑器本身、集成终端(用于讲述的命令想法)和markdown预览文件。它也在VS Code的settings JSON和其他您可能想添加注释的配置文件中工作。

VS Code的最佳增强模式:Dev Task

Dev Task模式专为开发工作流程文档设计。当您激活它并讲述关于一段代码或任务的内容时,AI将您的输出结构化为具有四个部分的开发就绪格式:

背景:解释此代码做什么、为何存在或解决什么问题的背景信息。

要求:实现需要满足的内容——约束、依赖、边界情况或业务规则。

实现笔记:技术细节、采取的方法、考虑的权衡或重要警告。

验收标准:如何验证实现是否正确——应该通过什么测试、预期什么行为或什么条件定义成功。

此结构立即有用于:

  • 解释复杂逻辑的函数级文档块
  • 用于非显而易见模块的文件级标题注释
  • 在代码文件中直接规划工作时的任务描述
  • 在markdown中起草的架构决定记录(ADR)

对于更简单的内联注释——关于正则表达式的快速解释、关于已知限制的注释——清洁和正确模式给您干净、可读的散文,没有正式的结构。

前后对比示例

原始语音输入(Dev Task模式):

"所以这个函数处理API的速率限制 呃 它需要跟踪每个用户每分钟的请求 它应该使用滑动窗口而不是固定窗口 因为固定窗口可能允许在边界处爆发流量 呃 它依赖Redis用于计数器存储 它应该在超过限制时返回429和retry-after头 我们还应该确保限制键自动过期,这样我们不会随着时间推移填满Redis"

Dev Task模式之后:

背景 使用滑动窗口算法处理每用户API速率限制。使用Redis进行分布式计数器存储以支持多实例部署。

要求

  • 使用滑动窗口跟踪每个用户每分钟的请求(不是固定窗口)
  • 当超过限制时返回HTTP 429和Retry-After
  • Redis键必须自动过期以防止无界存储增长

实现笔记

  • 选择滑动窗口而不是固定窗口以防止在窗口边界处的爆发流量
  • 分布式速率限制状态需要Redis依赖

验收标准

  • 速率限制在持续和爆发流量模式下正确执行
  • Redis键按预期过期(使用TTL命令验证)
  • 429响应包括有效的Retry-After
  • 在延长的测试期后没有Redis键累积

讲述的版本是一个漫无边际的解释。Dev Task输出是您可以直接粘贴在函数上方作为文档块的结构化规范。

时间节省

文档因写作缓慢而相对于其感知价值而经常被优先级排序。切换到语音文档的开发者报告两个变化:他们记录更多,而且记录更好。

编写彻底的函数文档块需要5到8分钟的集中输入。讲述相同内容需要60到90秒,Dev Task模式处理格式化。减少的时间投资使文档感觉可行而不是繁重。

对于更长的文档——README、架构决定记录、入职指南——时间节省按比例扩展。一个需要45分钟编写的一千字README可以在10到12分钟内听写,然后从那里编辑。

还有一个质量论证。当文档在编写代码后立即草稿时,当实现细节仍然新鲜时,生成的文档更准确、更有用。Telvr的速度使在编码时文档实际可行而不是作为延期任务。

在一个典型的开发周,有定期文档工作,Telvr可以恢复2到3小时——并作为副作用产生一个更好记录的代码库。

入门指南

  1. telvr.ai为macOS下载Telvr。
  2. 完成设置并配置您首选的麦克风。
  3. 设置一个在您的VS Code工作流程中工作的热键——您可以按下而无需将手移动很远的东西。
  4. 打开VS Code,在函数上方或在文档块中放置光标,并测试您的第一次听写。
  5. 将Dev Task设置为开发文档工作的默认模式。

一个很好的第一个练习:找到您当前项目中最复杂的三个函数——最受益于清晰文档的函数——并为每个听写一个Dev Task块。整个练习应该花费不到10分钟,并产生需要一小时编写的文档。

Telvr包括14天的免费试用,可以完全访问所有增强模式。试用后,价格是每月3欧元加上每分钟0.003欧元起的转录。