Piattaforma gratuita e centralizzata di documentazione per team tecnici

La maggior parte dei team di ingegneria non ha effettivamente bisogno di una nuova piattaforma di documentazione centralizzata. Ne hanno già una (Confluence, Notion, GitHub wiki, un portale di sviluppo interno). Ciò di cui hanno bisogno è un modo per popolarla con documentazione tecnica che rimanga aggiornata. Lo strumento di documentazione tecnica di Trupeer AI registra un flusso di lavoro una sola volta e produce un video walkthrough rifinito più una guida tecnica scritta, pronta per essere incorporata in qualsiasi strumento il team utilizzi già come livello di documentazione centrale. Il collo di bottiglia sulla maggior parte dei documenti tecnici è la produzione, non l'archiviazione.

• Registra un flusso di lavoro tecnico una sola volta. Ottieni un video rifinito e una guida tecnica scritta nello stesso processo.

• Incorpora l'output in qualsiasi piattaforma di documentazione centralizzata esistente: Confluence, Notion, GitHub wiki, portale di sviluppo interno.

• Aggiorna registrando nuovamente il passaggio modificato. Il resto della documentazione tecnica rimane intatto.

• Traduci la documentazione tecnica in oltre 65 lingue per i team di ingegneria globali.

• Condividi tramite un link a una Pagina Condivisa personalizzata che il team può pubblicare su Slack, incorporare in qualsiasi wiki o passare all'assistenza.

Cosa produce Trupeer AI per la documentazione tecnica

Un ingegnere registra un walkthrough dello schermo di una distribuzione, una sessione di debug, una procedura di risposta agli incidenti o qualsiasi altro flusso di lavoro tecnico. Trupeer AI gestisce la post-produzione. Le parole riempitive e i momenti in cui si esita a trovare la scheda giusta vengono rimossi. Il tremolio del cursore e le transizioni di zoom vengono fluidificati. Una bozza del video e una bozza della guida tecnica scritta arrivano insieme, in modo che il team non debba mantenere due fonti di verità separate per la stessa procedura.

L'output video è in formato MP4, pronto per essere incorporato in qualsiasi software di documentazione tecnica. L'output del documento è in formato PDF o Word, pronto per il wiki di ingegneria o per essere passato a un revisore. Il kit di branding si applica automaticamente: logo aziendale, colori, font, slide di introduzione e chiusura corrispondono al resto della libreria di documentazione ingegneristica. Il glossario personalizzato gestisce i nomi dei prodotti interni, i nomi degli strumenti e i nomi delle API che altrimenti l'IA non saprebbe come scrivere o pronunciare, il che è fondamentale per i contenuti tecnici più che per qualsiasi altro tipo di documentazione. Il livello di registrazione dello schermo IA gestisce l'evidenziazione del cursore, la messa a fuoco dell'area e lo zoom automatico sulle interazioni dell'interfaccia utente, cose che la maggior parte degli strumenti di scrittura tecnica ignora o esegue male.

Come funziona lo strumento di documentazione tecnica in tre passaggi

L'intero flusso richiede una sola registrazione e produce documentazione tecnica pronta per la condivisione. Nessuno script di preparazione, nessun passaggio di scrittura tecnica separato, nessun backlog di documentazione da smaltire nei successivi due trimestri.

Passaggio 1: Registra il flusso di lavoro tecnico

Avvia la registrazione nel browser, acquisisci il flusso di lavoro mentre viene effettivamente eseguito o carica una registrazione dello schermo esistente. L'intelligenza artificiale lavora su ciò che viene registrato. Registrare una distribuzione di 12 minuti è più veloce che scrivere a memoria un runbook di 4 pagine, e ciò che si ottiene è più accurato perché la documentazione riflette ciò che l'ingegnere ha effettivamente fatto, non quello che ricorda di aver fatto.

Passaggio 2: Trupeer AI genera il video e la guida tecnica scritta

Le parole riempitive vengono rimosse. Gli effetti di zoom e del cursore vengono aggiunti laddove aiutano lo spettatore a seguire ciò che accade sullo schermo. Una bozza di video e una bozza di guida tecnica appaiono insieme nell'editor. Si applica il glossario personalizzato, in modo che i nomi degli strumenti interni, gli endpoint API e i nomi dei prodotti vengano scritti e pronunciati correttamente in entrambi gli output.

Passaggio 3: Brandizza, traduci e pubblica sul livello di centralizzazione esistente

Applica il brand kit in modo che il logo aziendale, i colori e le diapositive di intro/outro corrispondano al resto della libreria di documentazione ingegneristica. Traduci nelle lingue parlate dal team di ingegneria globale (spagnolo, mandarino, hindi, portoghese o in una qualsiasi delle oltre 65 opzioni). Quindi pubblica tramite un link della Pagina Condivisa che il team può incorporare in Confluence, Notion, il wiki di GitHub, il portale di sviluppo interno o qualsiasi altra piattaforma di documentazione centralizzata già utilizzata.

Chi utilizza effettivamente Trupeer AI per la documentazione tecnica

La persona che apre questo strumento è solitamente un tech lead, un engineering manager o un DevOps lead di un'azienda in cui la "documentazione" è stata indicata come OKR per almeno due trimestri consecutivi. Costantemente, il team di ingegneria sa cosa deve essere documentato. Quello che non ha è qualcuno disposto a passare una settimana a scrivere ciò che potrebbe registrare in 30 minuti. Trupeer AI colma il divario tra il sapere cosa dovrebbe essere documentato e il produrre effettivamente la documentazione.

Lo stesso flusso di lavoro si applica a vari ruoli. I team SRE e DevOps lo utilizzano per runbook di risposta agli incidenti, procedure di deployment e walkthrough dell'infrastruttura. I team di platform engineering lo utilizzano per la documentazione degli strumenti interni che spiega come funzionano effettivamente i sistemi sviluppati internamente. I manager di ingegneria lo utilizzano per pubblicare la documentazione di onboarding per i nuovi assunti, coprendo la configurazione dell'ambiente, le convenzioni sulla base di codice e gli strumenti specifici del team. I team di developer experience lo utilizzano per creare documentazione tecnica per le API interne e le librerie condivise da cui dipende il resto dell'azienda. Alcuni team lo considerano un sostituto per l'assunzione di un redattore di documentazione tecnica; altri lo utilizzano insieme a quest'ultimo per moltiplicarne la produttività.

Casi d'uso della documentazione tecnica gestiti da Trupeer AI

La documentazione tecnica di solito copre quattro tipi di contenuto: come funziona qualcosa, come fare qualcosa, cosa è successo quando qualcosa si è rotto e dove sono i confini tra i sistemi. Trupeer AI gestisce tutti e quattro attraverso lo stesso flusso di registrazione in documento. I walkthrough di deployment, le guide alla configurazione dell'ambiente, le analisi post-mortem degli incidenti e le panoramiche di architettura iniziano tutte come una registrazione dello schermo e finiscono come un video rifinito più una guida tecnica scritta. Quello che prima richiedeva un modello di scrittura tecnica, o un file di testo generico per la documentazione tecnica, diventa ciò che l'ingegnere desidera produrre, strutturato automaticamente dall'intelligenza artificiale. I team che in precedenza valutavano software di scrittura tecnica separati solo per ottenere un modello utilizzabile di solito abbandonano quel livello una volta implementato Trupeer.

Per la documentazione tecnica del software, il caso d'uso che ripaga più rapidamente è la presentazione dei tool interni. Ogni team di ingegneria ha almeno una manciata di strumenti sviluppati in casa che nessuno al di fuori del team sa come usare. Registrare l'uso effettivo di quegli strumenti e produrre sia la documentazione video che quella scritta in un'unica operazione significa che il prossimo ingegnere che dovrà utilizzare lo strumento non dovrà chiedere informazioni su Slack al team che lo ha creato. Lo stesso pattern si applica alla documentazione di progettazione tecnica: invece di redigere il design a posteriori, registra la riunione di revisione del design e lascia che Trupeer AI generi il documento tecnico strutturato a partire da essa. La redazione di report tecnici per post-mortem e analisi delle cause principali funziona nello stesso modo: registra la sessione di analisi, genera il documento, pubblicalo.

L'IA per la scrittura tecnica guadagna il suo posto quando il team si rende conto di poter aggiornare la documentazione tecnica esistente registrando nuovamente, invece di trattare ogni aggiornamento come una riscrittura completa. La stessa logica si applica più in generale alla scrittura di contenuti tecnici. I team di ingegneria smettono di evitare la documentazione quando il costo per produrla scende al di sotto del costo di spiegare la stessa cosa su Slack quattro volte al trimestre. Questo cambiamento è il vero mutamento strutturale che una piattaforma di documentazione centralizzata per i team tecnici dovrebbe consentire, ed è il divario che la maggior parte delle piattaforme lascia da risolvere al team da solo. Trupeer AI è lo strumento a cui la maggior parte dei team ricorre come esempio di documentazione tecnica software, perché l'output è sufficientemente concreto da essere utilizzato come riferimento per mostrare come appare in pratica una buona scrittura e documentazione tecnica.

Dove si colloca Trupeer AI rispetto a Confluence, Notion, GitHub wiki e altri strumenti di centralizzazione

Trupeer AI non sostituisce il livello di centralizzazione. Il wiki rimane il wiki. Confluence rimane il luogo in care vive la documentazione di ogni team. Notion rimane la knowledge base interna del team di ingegneria. Il wiki di GitHub rimane lo spazio documentale adiacente al repository. Il portale degli sviluppatori interno rimane la fonte canonica di verità. Trupeer AI si colloca un passo prima nel flusso di lavoro, laddove i contenuti della documentazione vengono effettivamente prodotti, e invia l'output come un collegamento a una Pagina Condivisa incorporabile in uno qualsiasi di questi layer di centralizzazione esistenti, senza modificare la configurazione già in uso.

La maggior parte dei team di ingegneria ha già investito nel proprio strumento di centralizzazione preferito. Non vogliono migrare, vogliono che lo strumento esistente contenga effettivamente documentazione aggiornata. Il collegamento alla Pagina Condivisa di Trupeer AI è il meccanismo che colma questo divario: sia il video che il documento si aggiornano quando si aggiorna la registrazione sottostante, il che significa che chiunque abbia il collegamento incorporato nel wiki del proprio team visualizza automaticamente la versione corrente. Il wiki rimane il livello di archiviazione e di ricerca. Trupeer AI gestisce la produzione a monte e la manutenzione continua, cose che la maggior parte delle piattaforme di centralizzazione lasciano gestire ai team da soli.

Aggiornamenti: registra nuovamente il passaggio modificato, mantieni intatto il resto della documentazione tecnica

La documentazione tecnica invecchia più velocemente di qualsiasi altra perché i sistemi sottostanti cambiano settimanalmente. Un processo di deployment si modifica quando il team migra a una nuova piattaforma CI/CD. Il runbook degli incidenti cambia quando cambia il fornitore del database. Le guide di onboarding cambiano quando il team adotta un nuovo IDE o passa a un diverso strumento di revisione del codice. La maggior parte degli strumenti di documentazione costringe il team a riscrivere da zero le sezioni interessate ogni volta. Trupeer AI gestisce gli aggiornamenti registrando nuovamente solo il passaggio che è cambiato.

Registrare nuovamente è più veloce che riscrivere. L'ingegnere che ha registrato originariamente il flusso di lavoro registra la nuova versione del passaggio modificato. L'IA rielabora solo quel segmento. Sia il video che la guida tecnica scritta si aggiornano nello stesso spazio. Qualsiasi collegamento alla Pagina Condivisa distribuito dal team lo scorso trimestre ora indirizza alla versione corrente, con il passaggio aggiornato integrato nel resto della documentazione. Chiunque abbia salvato il collegamento originale o lo abbia incorporato nella wiki del team riceve i nuovi contenuti senza alcuna rincorsa manuale. Questo modello di aggiornamento è ciò che consente alla documentazione tecnica di rimanere utilizzabile nel corso dei mesi e degli anni in cui i sistemi continuano a cambiare. L'associazione del generatore con il creatore di SOP Trupeer AI copre le procedure operative standard che stanno alla base dei flussi di lavoro tecnici registrati.