Scrittura tecnica
Manuali, guide e documentazione che un utente può seguire senza contattare l'assistenza.
Caratteristiche principali
- Piano di documentazione: destinatari, tipi di contenuto, albero delle pagine
- Articoli, guide o capitoli di manuale in Markdown, Word o nel suo strumento di help centre
- Screenshot annotati e diagrammi dove un passaggio li richiede
- Elenco terminologico e guida di scrittura per i futuri collaboratori
- Qui non si paga nullaRicevi prima un preventivo scritto. Nessun pagamento, nessun impegno.
- Venduto e consegnato da GRADAXUn contratto e un team, chiunque svolga il lavoro.
- I suoi dati restano nell'UENulla viene spostato fuori dall'Unione per essere elaborato.
Informazioni su questo servizio
Guide utente, documentazione API, procedure operative standard e articoli per la knowledge base, scritti da chi esegue ogni passaggio nel prodotto prima di metterlo per iscritto. La documentazione è strutturata in modo che il suo team possa mantenerla dopo la consegna, nello strumento che già utilizza.
Documentazione scritta dal prodotto, non dalle specifiche
La maggior parte della cattiva documentazione è stata scritta da un documento dei requisiti o dalla memoria di uno sviluppatore. Descrive come la funzione doveva funzionare, non la schermata che l'utente vede davvero, con il suo pulsante rinominato e il suo passaggio di conferma in più. L'utente segue il passo quattro, non trova nulla che corrisponda e apre un ticket.
Eseguiamo ogni procedura nel prodotto prima di scriverla, su un account di test, nel ruolo che avrà il lettore. Dove un passaggio si comporta diversamente da ciò che il team si aspetta, lo registriamo, perché il lavoro sulla documentazione fa emergere regolarmente bug che nessuno aveva segnalato. Quell'elenco si rivela spesso prezioso quanto la documentazione.
Separare l'operazione dalla spiegazione
Un utente che cerca di esportare una fattura non vuole prima tre paragrafi sul modello di fatturazione. Un utente che cerca di capire il modello di fatturazione non vuole un elenco numerato di clic. Mescolare le due cose in un unico articolo rende entrambe più difficili da trovare e più lente da leggere.
Suddividiamo i contenuti in operazioni (come fare una cosa), concetti (come funziona qualcosa e perché) e riferimento (impostazioni, campi, limiti, codici di errore). Ogni tipo ha il suo modello, così le pagine restano coerenti dopo la consegna e quando il Suo team aggiunge il quarantesimo articolo.
Il glossario è ciò che mantiene coerente l'insieme nel tempo. Se l'interfaccia dice 'area di lavoro', la documentazione non dice mai 'progetto' o 'account' per la stessa cosa. È un piccolo documento che previene la maggior parte della confusione segnalata dagli utenti.
- Articoli operativi: un obiettivo, passaggi numerati, il risultato che l'utente dovrebbe vedere
- Articoli concettuali: il modello dietro una funzione, con un diagramma dove aiuta
- Pagine di riferimento: ogni campo, impostazione e limite, in una tabella di rapida consultazione
- Risoluzione dei problemi: il messaggio di errore così com'è scritto, la sua causa e la soluzione
Specifiche
- Categoria
- Contenuti e copy
- Prezzo
- Da 420 € a 1520 €
- Dimensioni
- Piccolo (Una guida), Medio (Sezione di help centre), Grande (Set di documentazione)
- Tempi di consegna
- Da 2 a 8 settimane
- Fatturato
- Una tantum
- Cosa ottiene
- 4 voci, tutte incluse nel prezzo
- Cosa ci serve da lei
- Accesso al prodotto o a un ambiente di test, Un esperto di dominio per una call di revisione per sezione, Documentazione esistente, ticket di assistenza o risposte salvate, qualunque cosa esista
- Acquistato più spesso da
- SaaS, Produzione industriale, Tecnologia sanitaria, Logistica
- Venduto e consegnato da
- GRADAX, un contratto e un unico team
- Dove vengono trattati i tuoi dati
- Unione Europea
Cosa ottiene
Tutto ciò che segue è incluso nel prezzo. Nulla qui è un upgrade.
- Piano di documentazione: destinatari, tipi di contenuto, albero delle pagine
- Articoli, guide o capitoli di manuale in Markdown, Word o nel suo strumento di help centre
- Screenshot annotati e diagrammi dove un passaggio li richiede
- Elenco terminologico e guida di scrittura per i futuri collaboratori
Cosa cambia
- Ogni procedura testata passo per passo sul prodotto reale
- Un compito per articolo, trovabile dalla ricerca del suo help centre
- La stessa cosa chiamata con lo stesso nome su ogni pagina
- Una struttura che il suo team può estendere senza chiedere a noi
Confronta le dimensioni
Il prezzo standard per ogni dimensione. Gli extra sono prezzati accanto, non nascosti dietro una call.
| Incluso | Una guida420 €Da 2 a 3 settimane | Sezione di help centre720 €Da 4 a 5 settimane | Set di documentazione1520 €Da 6 a 8 settimane |
|---|---|---|---|
| Piano di documentazione per una guida | Incluso | Incluso | Incluso |
| Fino a 15 pagine o articoli | Incluso | Incluso | Incluso |
| Screenshot annotati | Incluso | Incluso | Incluso |
| Un ciclo di revisione tecnica | Incluso | Incluso | Incluso |
| Tutto ciò che è incluso in Una guida, fino a 40 articoli | Non incluso | Incluso | Incluso |
| Articoli di tipo task, concetto e riferimento separati | Non incluso | Incluso | Incluso |
| Elenco terminologico | Non incluso | Incluso | Incluso |
| Due round di revisione | Non incluso | Incluso | Incluso |
| Tutto ciò che è incluso in Sezione di help centre | Non incluso | Non incluso | Incluso |
| Riferimento API con richieste di esempio testate | Non incluso | Non incluso | Incluso |
| Guida di scrittura per il suo team | Non incluso | Non incluso | Incluso |
| Documentazione esistente migrata nella nuova struttura | Non incluso | Non incluso | Incluso |
| Aggiungi al preventivo |
Aggiunga ciò che le serve
Choose the size
Aggiunga ciò che le serve
Il suo totale€720
Il prezzo standard, più ciò che aggiunge. Confermato per iscritto prima che qualsiasi cosa inizi; nulla viene addebitato finché lei non accetta.
Come funziona
Mappatura
Chi legge la documentazione, cosa sta cercando di fare e dove si blocca oggi.
Test
Ogni compito eseguito nel prodotto, con ogni clic e schermata registrati.
Scrittura
Contenuti di tipo task, concetto e riferimento tenuti separati, così ogni pagina risponde a una sola domanda.
Verifica
Il suo esperto verifica l'accuratezza; noi verifichiamo che un nuovo utente possa seguirlo.
Domande
Potete scrivere documentazione API?
Sì, da un file OpenAPI o dal codice più il tempo di uno sviluppatore. Ogni richiesta di esempio viene eseguita su un ambiente di test prima della pubblicazione.
Con quali strumenti lavorate?
Markdown in un repository, Confluence, Notion, Zendesk Guide, Intercom o Word quando l'output è un manuale stampato. Usiamo lo strumento che il suo team manterrà.
Scrivete documentazione regolamentata?
Scriviamo procedure e manuali chiari. I documenti che devono rispettare uno standard di certificazione richiedono l'approvazione della sua persona qualificata, e lavoriamo sulla loro checklist.
Ricerche correlate
Lavori correlati
Una tantumUX writingLe parole dentro il suo prodotto: pulsanti, errori, schermate vuote e onboarding.from 290 €
Una tantumSviluppo di contenuti eLearningCorsi costruiti dalla conoscenza dei Suoi esperti, strutturati per chi apprende e pronti per il Suo LMS.from 290 €
Una tantumTemplate per documenti aziendaliTemplate per proposte, preventivi, fatture e report in Word o Google Docs che mantengono il loro layout.from 290 €
Una tantumSintesi di ricercaLunghi report e paper trasformati in briefing che si leggono in dieci minuti.from 290 €
Una tantumScript video per social mediaScript per Reels, TikTok e Shorts, con l'hook scritto per i primi due secondi.from 290 €
Una tantumScrittura di case studyStorie di clienti scritte da un'intervista al cliente, con numeri che lui approva.from 290 €
Nessun pacchetto è adatto?
Alcuni lavori hanno una forma propria. Li analizziamo prima e ne definiamo il preventivo per iscritto; la chiamata di analisi è gratuita.