Tehničko pisanje
Priručnici, vodiči i dokumentacija koje korisnik može pratiti bez pozivanja podrške.
Ključne značajke
- Plan dokumentacije: ciljne skupine, vrste sadržaja, stablo stranica
- Članci, vodiči ili poglavlja priručnika u Markdownu, Wordu ili alatu vašeg centra za pomoć
- Anotirani snimci zaslona i dijagrami tamo gdje su potrebni za objašnjenje koraka
- Popis terminologije i smjernice za pisanje za buduće suradnike
- Ovdje se ništa ne naplaćujePrvo dobivate pisanu ponudu. Bez plaćanja, bez obveze.
- Prodaje i isporučuje GRADAXJedan ugovor i jedan tim, bez obzira tko izvodi radove.
- Vaši podaci ostaju u EUNišta se ne prenosi izvan Unije radi obrade.
O ovoj usluzi
Korisnički vodiči, API dokumentacija, standardni operativni postupci i članci baze znanja, pisani od strane nekoga tko izvrši svaki korak u proizvodu prije nego ga zapiše. Dokumentacija je strukturirana tako da ju vaš tim može održavati nakon prijenosa, u alatu koji već koristi.
Dokumentacija pisana iz perspektive proizvoda, a ne specifikacije
Većina loše dokumentacije nastaje na temelju zahtjeva ili sjećanja developera. Opisuje kako je značajka trebala raditi, a ne zaslon koji korisnik zapravo vidi, s preimenovanim gumbom i dodatnim korakom potvrde. Korisnik prati četvrti korak, ne nalazi ništa što odgovara i otvara tiket.
Svaki postupak u proizvodu provodimo prije pisanja, na testnom računu, u ulozi koju će imati čitatelj. Kada se korak ponaša drugačije nego što tim očekuje, bilježimo to jer dokumentacijski posao rutino otkriva bugove koje nitko nije prijavio. Taj popis često bude jednako vrijedan kao i sama dokumentacija.
Odvojite zadatak od objašnjenja
Korisnik koji želi izvesti račun ne želi tri odlomka o modelu naplate na početku. Korisnik koji želi razumjeti model naplate ne želi numerirani popis klikova. Miješanje ova dva u jednom članku otežava pronalaženje i usporava čitanje.
Sadržaj dijelimo na zadatke (kako napraviti jednu stvar), koncepte (kako nešto funkcionira i zašto) i referencu (postavke, polja, ograničenja, kodovi pogrešaka). Svaka vrsta ima svoj predložak, pa stranice ostaju dosljedne nakon što ih predamo, a vaš tim doda četrdeseti članak.
Popis terminologije održava koherentnost skupa s vremenom. Ako sučelje koristi riječ 'radni prostor', dokumentacija nikada ne koristi 'projekt' ili 'račun' za istu stvar. To je mali dokument koji sprječava većinu zabuna koje korisnici prijavljuju.
- Članci o zadacima: jedan cilj, numerirani koraci, rezultat koji korisnik treba vidjeti
- Konceptualni članci: model iza značajke, s dijagramom gdje pomaže
- Referentne stranice: svako polje, postavka i ograničenje u preglednoj tablici
- Rješavanje problema: poruka o pogrešci onako kako glasi, uzrok i rješenje
Specifikacije
- Kategorija
- Sadržaj i copywriting
- Cijena
- 420 € do 1.520 €
- Veličine
- Malo (Jedan vodič), Srednje (Odjeljak centra za pomoć), Veliko (Set dokumentacije)
- Vrijeme izrade
- 2 do 8 tjedana
- Naplaćeno
- Jednokratno
- Što dobivate
- 4 stavki, sve uključeno u cijenu
- Što nam trebate dostaviti
- Pristup proizvodu ili testnom okruženju, Stručnjak za predmetnu oblast za jedan poziv na pregled po odjeljku, Postojeća dokumentacija, tiketi podrške ili spremljeni odgovori, što god postoji
- Najčešće kupuju
- SaaS, Proizvodnja, Zdravstvena tehnologija, Logistika
- Prodaje i isporučuje
- GRADAX, jedan ugovor i jedan tim
- Gdje se obrađuju vaši podaci
- Europska unija
Što dobivate
Sve što slijedi uključeno je u cijenu. Ništa ovdje nije nadogradnja.
- Plan dokumentacije: ciljne skupine, vrste sadržaja, stablo stranica
- Članci, vodiči ili poglavlja priručnika u Markdownu, Wordu ili alatu vašeg centra za pomoć
- Anotirani snimci zaslona i dijagrami tamo gdje su potrebni za objašnjenje koraka
- Popis terminologije i smjernice za pisanje za buduće suradnike
Što se mijenja
- Svaki postupak testiran korak po korak protiv pravog proizvoda
- Jedan zadatak po članku, pronalažljiv putem pretraživanja vašeg centra za pomoć
- Ista stvar nazvana istim imenom na svakoj stranici
- Struktura koju vaš tim može proširiti bez da nas pita
Usporedite pakete
Standardna cijena za svaku veličinu. Dodatne stavke cijene se uz nju, a ne kriju iza poziva.
| Uključeno | Jedan vodič420 €2 do 3 tjedna | Odjeljak centra za pomoć720 €4 do 5 tjedana | Set dokumentacije1.520 €6 do 8 tjedana |
|---|---|---|---|
| Plan dokumentacije za jedan vodič | Uključeno | Uključeno | Uključeno |
| Do 15 stranica ili članaka | Uključeno | Uključeno | Uključeno |
| Anotirani snimci zaslona | Uključeno | Uključeno | Uključeno |
| Jedan krug tehničkog pregleda | Uključeno | Uključeno | Uključeno |
| Sve iz Jednog vodiča, do 40 članaka | Nije uključeno | Uključeno | Uključeno |
| Zadatci, koncepti i referentni članci odvojeni | Nije uključeno | Uključeno | Uključeno |
| Popis terminologije | Nije uključeno | Uključeno | Uključeno |
| Dva kruga pregleda | Nije uključeno | Uključeno | Uključeno |
| Sve iz Odjeljka centra za pomoć | Nije uključeno | Nije uključeno | Uključeno |
| API referenca s testiranim primjerima zahtjeva | Nije uključeno | Nije uključeno | Uključeno |
| Smjernice za pisanje za vaš tim | Nije uključeno | Nije uključeno | Uključeno |
| Postojeća dokumentacija migrirana u novu strukturu | Nije uključeno | Nije uključeno | Uključeno |
| Dodaj u ponudu |
Dodajte što vam treba
Choose the size
Dodajte što vam treba
Vaš ukupni iznos€720
Standardna cijena, plus sve što dodate. Potvrđeno u pisanom obliku prije početka; ništa se ne naplaćuje dok ne prihvatite.
Kako funkcionira
Mapa
Tko čita dokumentaciju, što pokušavaju učiniti i gdje zapinju danas.
Testiranje
Svaki zadatak izvršen u proizvodu, uz snimanje svakog klika i ekrana.
Pisanje
Zadatci, koncepti i referentni sadržaj odvojeni, tako da svaka stranica odgovara na jedno pitanje.
Pregled
Vaš stručnjak provjerava točnost; mi provjeravamo može li početnik pratiti.
Pitanja
Možete li pisati API dokumentaciju?
Da, iz OpenAPI datoteke ili iz koda plus vrijeme developera. Svaki primjer zahtjeva pokreće se protiv testnog okruženja prije objave.
U kojim alatima radite?
Markdown u repozitoriju, Confluence, Notion, Zendesk Guide, Intercom ili Word kada je rezultat tiskani priručnik. Koristimo ono što će vaš tim održavati.
Pišete li reguliranu dokumentaciju?
Pišemo jasne postupke i priručnike. Dokumenti koji moraju zadovoljiti certifikacijski standard trebaju potvrdu vaše kvalificirane osobe, a mi radimo prema njihovom popisu.
Povezane pretrage
Povezani poslovi
JednokratnoUX pisanjeRiječi unutar vašeg proizvoda: gumbi, poruke o pogreškama, prazni zasloni i onboarding.from 290 €
Jednokratnorazvoj eLearning sadržajaTečajevi izgrađeni na temelju znanja vaših stručnjaka, strukturirani za učenike i spremni za vaš LMS sustav.from 290 €
JednokratnoPoslovni predlošci dokumenataPredlošci za ponude, račune i izvješća u Wordu ili Google Docsima koji zadržavaju svoj izgled.from 290 €
JednokratnoSažeci istraživanjaDugi izvještaji i radovi pretvoreni u briefinge koje možete pročitati za deset minuta.from 290 €
JednokratnoScenariji za videozapise na društvenim mrežamaScenariji za Reels, TikTok i Shorts, s uvodnom rečenicom (hook) napisanom za prve dvije sekunde.from 290 €
JednokratnoPisanje studije slučajaPriče o kupcima napisane na temelju intervjua s kupcem, s brojkama koje oni potvrđuju.from 290 €
Ne odgovara standardnoj veličini?
Neki radovi imaju vlastiti opseg. Prvo procjenjujemo opseg i nudimo pisanu ponudu, a poziv za procjenu ne košta ništa.