Röstprogrammering i VS Code: Diktara kommentarer och dokumentation

Problemet

Utvecklare skriver mer text än de flesta inser. Bortom själva koden finns det en konstant ström av icke-kodskrivning som inträffar i VS Code: inline-kommentarer, funktions docstrings, README-avsnitt, commit meddelandeutkast, biljettbeskrivningar, todo-anteckningar och arkitektur beslutanteckningar.

Denna skrivning behandlas ofta som sekundär — något att göra snabbt eller upskjuta tills senare. Resultatet är kodförråd med gles dokumentation, funktioner utan förklaring av varför de existerar och arkitektur beslut som endast existerar i någons minne.

Friktionen är verklig. Efter att ha spenderat mental energi på en komplex algoritm är det sista de flesta utvecklare vill göra är att skriva ett stycke som förklarar det. Att skriva känns som ytterligare arbete på toppen av det riktiga arbetet. Men dokumentation skriven omedelbar efter implementering — medan kontexten är färsk — är dramatiskt mer värdefull än dokumentation skriven en vecka senare, eller aldrig alls.

Hur Telvr fungerar med VS Code

Telvr integreras med VS Code och andra textredigerare genom systemlevel markörposition-infogning. Inget VS Code-tillägg krävs. Ingen API-nyckel i din redige. Ingen konfiguration i VS Code själv.

Arbetsflödet för utvecklingsdokumentation:

1. Öppna VS Code och positionera din markör där du vill att dokumentationen ska visas — ovanför en funktion, i ett kommentarblock, i en README-fil eller i ett nytt markdown-dokument.
2. Tryck din Telvr-snabbtangent.
3. Prata din dokumentation, förklaring eller uppgiftsbeskrivning.
4. Släpp snabbtangenten. Den formaterad utmatningen visas vid markören under två sekunder.
5. Fortsätt koda.

Telvr fungerar i alla VS Code-sammanhang: redigeraren själv, den integrerad terminalen (för talande kommandoidéer) och markdown förhandsvisningsfiler. Det fungerar också i VS Code:s inställning JSON och andra konfigurationsfiler där du kan vilja lägga till kommentarer.

Bästa berikningsläge för VS Code: Dev Task

Dev Task-lägét är designat specifikt för utveckling arbetsflödesdokumentation. När du aktiverar det och pratar om en kodbiten eller en uppgift strukturerar AI din utmatning till ett utvecklingsklart format med fyra avsnitt:

Sammanhang: Bakgrundsinformation som förklarar vad denna kod gör, varför den existerar eller vad problem den löser.

Krav: Vad implementeringen måste uppfylla — begränsningar, beroenden, kantfall eller affärsregler.

Implementering anteckningar: Tekniska detaljer, tillvagagångssätt, trade-offs overväga eller viktiga förbehål.

Acceptans kriterier: Hur du verifierar att implementeringen är korrekt — vilka test ska passera, vilket beteende förväntas eller vilka villkor definierar framgång.

Denna struktur är omedelbar användbar för:

• Funktionsnivå dokumentationsblock som förklarar komplex logik
• Filnivå-rubrikkommentarer för icke-uppenbara moduler
• Uppgiftsbeskrivningar när du planerar arbete direkt i kodfiler
• Arkitektur beslut poster (ADRs) utarbetade i markdown

För enklare inline-kommentarer — en snabb förklaring av en regex, en anteckning om en känd begränsning — ger Rensa & korrigera lägét dig ren, läsbar prosa utan den formella strukturen.

Före och efter exempel

Raw talande inmatning (Dev Task läge):

"så den här funktionen hanterar hastighetsbegränsningen för API:et uh den måste spåra förfrågningar per användare per minut och den ska använda ett glidande fönster inte ett fast fönster eftersom fasta fönster kan tillåta burst trafik rätt vid gränsen um det beror på Redis för mottagarlagring och det ska returnera en 429 med en retry-after-rubrik när gränsen överskrids vi bör också se till att gränsen nycklarna upphör automatisk så vi inte fyller upp Redis över tiden"

Efter Dev Task läge:

Sammanhang Hanterar API-hastighetsbegränsning per användare med en glidande fönster-algoritm. Använder Redis för distribuerad mottagare lagring för att stödja multi-instans distributioner.

Krav

• Spåra förfrågningar per användare per minut med glidande fönster (inte fast fönster)
• Returnera HTTP 429 med Retry-After rubrik när gränsen överskrids
• Redis-nycklar måste upphöra automatisk för att förhindra obegränsad lagring tillväxt

Implementering anteckningar

• Glidande fönster valt över fast fönster för att förhindra burst trafik vid fönstergränser
• Redis beroende krävs för distribuerad hastighetsbegränst tillstånd

Acceptans kriterier

• Hastighetsbegränsningen tillämpas korrekt under höll och burst trafik mönster
• Redis-nycklarna upphör som förväntat (verifiera med TTL-kommandon)
• 429 svar inkluderar en giltig Retry-After rubrik
• Ingen Redis-nyckelackumulering efter utökad testperiod

Den talande versionen är en vädring förklaring. Dev Task-utmatningen är en strukturerad specifikation du kan klistra direkt ovanför funktionen som ett dokumentationsblock.

Tidsbesparing

Dokumentation är kronisk underprioriterad eftersom det är långsamt att skriva relativt till sitt uppfattade värde i stunden. Utvecklare som växlar till röstdokumentation rapporterar två förändringar: de dokumenterar mer och de dokumenterar bättre.

Att skriva en grundlig funktions dokumentationsblock tar fem till åtta minuters fokuserad skrivning. Att prata samma innehål tar sextio till nittio sekunder, och Dev Task-lägét hanterar formateringen. Den minskad tidsinvestering gör dokumentation kännas lönsam snarare än betungande.

För längre dokument — READMEs, arkitektur beslutsanteckningar, introduktionsguider — skalar tidsbesparing proportionell. En tusenordskrivna README som skulle ta fyrtiofem minuter att skriva kan dikteras på tio till tolv minuter och sedan redigeras därifrån.

Det finns också ett kvalitetsargument. När dokumentation utarbetas omedelbar efter att ha skrivit koden, medan implementeringsdetaljer är färska, är den resulterande dokumentationen mer exakt och mer användbar. Telvrs hastighet gör det praktisk att dokumentera medan du kodar snarare än som en uppskjuten uppgift.

Över en typisk utvecklingsvecka med regelbundet dokumentationsarbete kan Telvr återkräva två till tre timmar — och producera en bättre dokumenterad kodförråd som en bieffekt.

Komma igång

1. Ladda ner Telvr för macOS från telvr.ai.
2. Slutför inställningen och konfigurera din föredragna mikrofon.
3. Ställ in en snabbtangent som fungerar i ditt VS Code-arbetsflöde — något du kan trycka utan att flytta dina händer långt från hemraden.
4. Öppna VS Code, positionera din markör ovanför en funktion eller i ett dokumentationsblock och testa din första diktering.
5. Ställ in Dev Task som ditt standardläge för utvecklingsdokumentationsarbete.

En bra första övning: hitta de tre mest komplexa funktionerna i ditt nuvarande projekt — de som skulle dra mest nytta av tydlig dokumentation — och diktara ett Dev Task-block för varje. Hela övningen bör ta under tio minuter och producera dokumentation som skulle ha tagit en timme att skriva.

Telvr inkluderar en 14-dagars kostnadsfri provperiod med full åtkomst till alla berikningslägen. Efter provperioden är prissättningen EUR 3 per månad plus EUR 0,003 per minut transkription.