Servizi di technical writing
Servizi di technical writing per software house: riferimenti API, guide per sviluppatori, documentazione per gli utenti, runbook e note di rilascio, scritti come codice accanto al prodotto e mantenuti aggiornati a ogni release.
Di cosa si occupano i nostri technical writer
Documentazione delle API
Riferimento generato dal Suo schema OpenAPI o GraphQL, con guide introduttive, percorsi di autenticazione ed esempi eseguibili scritti attorno ad esso, così che il riferimento non venga mai modificato a mano.
Docs as code
Documentazione in Markdown nel Suo repository, rivista nelle pull request come il codice e pubblicata con Docusaurus, Starlight o un generatore analogo dalla stessa pipeline del prodotto.
Guide per gli utenti e help center
Guide orientate ai compiti e articoli dell’help center organizzati in base a ciò che il lettore sta cercando di fare, suddivisi in tutorial, guide pratiche, riferimento e spiegazione secondo il framework Diátaxis.
Runbook e guide operative
Procedure passo dopo passo per deployment, ripristini, incident response e reperibilità, collaudate da qualcuno che non le ha scritte.
Note di rilascio e changelog
Note di rilascio che dicono agli utenti che cosa è cambiato per loro e changelog per gli integratori, redatti dalle pull request integrate e verificati rispetto alla release.
Controlli di stile e qualità
Una guida di stile e un glossario applicati da Vale nella pipeline, con il controllo dei link interrotti a ogni build: la coerenza non dipende da un singolo revisore.
Ingaggiare technical writer
A tempo pieno nel Suo team
Technical writer che lavorano secondo i Suoi orari, con i Suoi strumenti e nelle Sue riunioni e rispondono al Suo responsabile, con contratto ucraino, buste paga e ferie a nostro carico.
Part time o frazionato
Technical writer per un numero stabilito di giorni a settimana, quando il lavoro c’è ma non basta ancora per un ruolo a tempo pieno.
Per un progetto o un lancio
Technical writer per un periodo di lavoro definito, dalla prima settimana alla consegna, con la data di fine concordata in anticipo.
La pagina sul team dedicato spiega come gli specialisti entrano nel Suo team, e la pagina sull’outsourcing tratta la realizzazione di progetti, le prese in carico e il modo in cui fatturiamo.
Con chi lavorano i nostri technical writer
Ingegneri e technical lead
Interviste, revisioni e accuratezza tecnica
Product manager
Funzionalità, destinatari e perimetro delle release
Support engineer
Le domande che gli utenti pongono davvero
Designer UI e UX
Testi dell’interfaccia e diagrammi
Come lavorano i nostri technical writer
La documentazione vive dove vive il codice: nel repository, revisionata nella stessa pull request della modifica che descrive, e compilata e pubblicata dalla pipeline. Una funzionalità è completata quando la sua documentazione è stata integrata nel ramo principale, e così la documentazione resta aggiornata quanto il codice.
Si scrive partendo dal lettore: chi è, che cosa vuole ottenere e che cosa sa già. I ticket di supporto e i termini di ricerca mostrano dove la documentazione attuale non funziona, e quelle pagine vengono corrette per prime.
Altri ruoli che forniamo
Project manager
Project management per la delivery software: project manager e delivery manager IT che rispondono di piani, perimetro, rischi, budget e report settimanali, a tempo pieno nel Suo team, part time o per un singolo progetto.
Business analyst
Analisi di business per progetti software: discovery, requisiti, user story, mappe di processo BPMN e criteri di accettazione, da business analyst a tempo pieno nel Suo team, part time o per un progetto.
Product manager
Product management per prodotti software: product manager e product owner per discovery, roadmap, backlog e metriche di prodotto, a tempo pieno nel Suo team, alcuni giorni alla settimana o per un lancio.
Scrum master
Scrum master e agile coaching per team software: Scrum e Kanban, metriche di flusso, impedimenti rimossi e retrospettive che cambiano qualcosa, a tempo pieno nel Suo team, part time o per un periodo definito.
Supporto tecnico
Servizi di supporto tecnico per prodotti software: support engineer di primo e secondo livello nel Suo help desk, con il Suo marchio e negli orari dei Suoi clienti, a tempo pieno, part time o per un lancio.
Selezione di personale IT
Servizi di selezione di personale IT per aziende che costruiscono i propri team: brief di ruolo, sourcing, screening e colloqui tecnici condotti da ingegneri in attività, da recruiter IT nel Suo team o per una campagna di assunzioni.
Customer success
Customer success management per prodotti SaaS e in abbonamento: customer success manager per onboarding, adozione, health score, QBR e rinnovi, a tempo pieno nel Suo team, part time o per un lancio.
Domande sull’ingaggio di technical writer
Un technical writer può documentare un sistema che nessuno ha mai documentato?
Sì. Il technical writer legge il codice e la configurazione, intervista gli ingegneri e produce una panoramica dell’architettura, runbook e un glossario, rivisti da chi gestisce il sistema. È lo stesso primo passo in sola lettura da cui partono le nostre prese in carico di sistemi ereditati.
Come mantenete la documentazione delle API allineata alle API?
La documentazione di riferimento viene generata dallo schema OpenAPI o GraphQL durante la build, quindi non può discostarsi dalle API. Il technical writer aggiunge ciò che un generatore non sa dare: la guida introduttiva, la spiegazione passo passo dell’autenticazione e gli esempi di cui uno sviluppatore ha bisogno prima che il riferimento gli sia utile.
Con quale rapidità possono iniziare technical writer?
Quando è disponibile il profilo giusto per il ruolo di technical writer, l’avvio dipende soltanto dal Suo colloquio e dalla firma dell’NDA e della cessione della proprietà intellettuale. Altrimenti avviamo una ricerca, che di norma produce profili di candidati entro due o tre settimane, e nessuno inizia finché Lei non ha detto di sì.
Come ingaggiare technical writer tramite BigTree108?
Ci indichi il lavoro, il livello di seniority e l’impegno orario necessario. Le proponiamo una o due persone con i rispettivi profili, Lei le intervista come farebbe con una Sua assunzione e firma un unico contratto con BIG TREE 108 LLC, ricevendo una sola fattura al mese.
A chi appartiene il lavoro che producono?
A Lei. Ogni specialista ha un contratto firmato con BigTree108 che cede all’azienda tutto il lavoro prodotto, e il nostro accordo con Lei lo cede a sua volta. Codice, design e documenti vengono consegnati nei Suoi repository e strumenti, non conservati dove solo noi possiamo modificarli.
La Sua documentazione è rimasta indietro rispetto al prodotto?
Ci indichi il prodotto, i suoi lettori e dove si trova oggi la documentazione. Riceverà una risposta entro un giorno lavorativo: profili di candidati o un piano per la documentazione.