Turinys
- Įsidėkite save į skaitytojo batus
- Ką reikia suprasti apie savo skaitytojus
- Jūsų skaitytojai jau nusivylę
- Pastaba prieš pradedant rašyti instrukcijas
- Stebuklinga formuluotė instrukcijoms rašyti
- Stebuklinga formulė: duotas-naujas metodas
- Dabar esate pasirengęs parašyti geras instrukcijas
- Galutinis valymas
- Patikrinkite savo instrukcijas naudojimu
- Išvados ir apibendrinimai
Laura yra technikos rašytoja. Ji mėgsta groti pianinu, keliauti, vaizduojamąjį meną ir kurti papuošalus.
Įsidėkite save į skaitytojo batus
Norėdami parašyti geresnes kompiuterio instrukcijas ar procedūras, pirmiausia turite įsitraukti į skaitytojo ar vartotojo batus.
Vartotojas nieko nežino apie jūsų svetainę ar programinę įrangą ir, prieš pradėdamas savo darbą, (ir neturėjo) skirti laiko perskaityti visą instrukcijų rinkinį. Vartotojas tiesiog naudoja jūsų produktą kažkokiam savo tikslui pasiekti (pirkti, ieškoti informacijos ir pan.).
Ką reikia suprasti apie savo skaitytojus
Visų pirmą. Turite sutikti su tuo, kad jūsų skaitytojai greičiausiai nenori skaityti to, ką parašėte. Tai reiškia, kad norėdami parašyti veiksmingas ir naudingas instrukcijas, pirmiausia turite sutikti su visomis šiomis tiesomis:
- Jūsų skaitytojai / vartotojai nenori išmokti naudotis jūsų produktu / paslauga; jie nori atlikti kokį nors savo uždavinį ar tikslą.
- Jie tik desperacijos metu perskaitė dokumentaciją, nes tai, ką bandė padaryti, nepavyko.
- Dabar jie nusivylę.
- Jie yra pamesti, kaip elgtis, kad įvykdytų savo tikslą / užduotį.
Jūsų skaitytojai jau nusivylę
Kaip instrukcijų rašytojas, jūs atsiduriate blogoje situacijoje, nes vartotojai (kurių tikriausiai nepažįstate ir niekada nesutiksite) jau nusivylę jūsų produktu / paslauga, kai jie pereina prie jūsų parašytų instrukcijų kaip atlikti kiekvieną užduotį. Taigi, būkite malonūs jiems ir duokite jiems aiškias, glaustas, išsamias, tikslias instrukcijas, kurios grąžins juos kuo greičiau pasiekti tikslą: tai yra gero klientų aptarnavimo forma!
Šablonas tampa gana lengvas ir taikomas daugeliui žingsnis po žingsnio pateikiamų instrukcijų tipų, ne tik kompiuterio instrukcijoms.
Pastaba prieš pradedant rašyti instrukcijas
Prieš pradėdami rašyti instrukcijas, turite žinoti, kokiu stiliumi jos turėtų būti parašytos.
Paprašykite „House Style Guide“ (rinkodaros skyrius yra gera vieta pradėti) ir gaukite naujausią „Microsoft“ stiliaus techninių leidinių vadovo kopiją.Bet kaip su „Apple Macintosh“ vartotojais? Jie arba jau yra susipažinę su „Microsoft“ rašymo stiliumi, arba jų nesupainios, nes rašymo stilių nuosekliai įgyvendinsite visoje naudojimo instrukcijoje.
Žodynas ir tezauras taip pat niekada nepakenkia, nors jų galima rasti ir internete, o kurį (-ius) naudoti (-ius), reikėtų nurodyti Namų stiliaus vadove. Jei abejojate, naudokite žodynų „auksinį standartą“ - „Merriam Webster“.
Stebuklinga formuluotė instrukcijoms rašyti
| Kur aš esu? | Ką turėčiau daryti? | Kas nutiko? |
|---|---|---|
Pasakykite skaitytojui, kur jie yra → | Pasakykite jiems, ką daryti → | Apibūdinkite jų veiksmų rezultatus |
Stebuklinga formulė: duotas-naujas metodas
Dabar žinote vieną iš techninės komunikacijos pagrindų, nesvarbu, ar esate profesionalus rašytojas, ar ne. Jis taip pat žinomas kaip duotas-naujas metodas, nes pirmiausia pasakai skaitytojui ką nors, ką jie jau žino, „duotą“, o tada duodi jam ką nors „naujo“. Aiškūs pavadinimai / antraštės yra raktas į sėkmę.
Atkreipkite dėmesį, kad šis metodas padeda jau nusivylusiam skaitytojui / vartotojui greitai suprasti, ar jūsų konkreti procedūra tinka jų situacijai, nes jūs jam davėte aiškų pavadinimą, ar jie yra teisingoje pradžios vietoje (nes jūs nurodėte, nuo ko pradėti), ką daryti daryti tuo metu ir kaip turėtų atrodyti rezultatai.
Dabar esate pasirengęs parašyti geras instrukcijas
Dabar, kai žinote rašymo taisykles, galite pradėti rašyti instrukcijas, visada atsižvelgdami į vartotojo perspektyvą.
Nurodote instrukcijas „Kaip atlikti užduotį ABC“ ir įsitikinkite, kad šios antraštės instrukcijos yra susijusios su užduoties ABC atlikimu (ir nieko kito). Dabar esate pasirengę patys parašyti instrukcijas.
Pirmiausia reikia orientuoti vartotojus: pasakykite vartotojams, kur jie yra ir ką turėtų matyti savo ekrane, pvz., Lango, į kurį jie turėtų žiūrėti, pavadinimą. Tada pasakykite jiems, kokį (-ius) mygtuką (-ius) paspausti dabartiniame lange ir (arba) kokį tekstą reikia įvesti į kokį (-ius) lauką (-us). Tada pasakykite jiems, kaip patekti į kitą žingsnį / vietą, ir apibūdinkite, ką jie turėtų matyti ekrane, kai atliks tą veiksmą.
Pavyzdžiui:
- Nuo Pagrindinis langas, pasirinkite visas norimas suaktyvinti parinktis. Spustelėkite Gerai. The Antrasis langas pasirodo dabartinė pasirinktų parinkčių būsena.
- Ant Antrasis langas, patikrinkite, ar visos pasirinktos parinktys yra teisingos.
- Jei visos parinktys teisingos, spustelėkite Suaktyvinti parinktis. The Trečias langas pasirodo.
- Jei parinktys nėra visos, spustelėkite Atgal grįžti į Pagrindinis langas ir pasirinkite skirtingas parinktis.
Galutinis valymas
Kai baigsite rašyti, paleiskite rašybos ir gramatikos tikrintuvą, tada paprašykite, kad vienas ar keli dalyko ekspertai (MVĮ) - žmonės, žinantys produktą, peržiūrėtų dokumentą. Atlikite bet kokius pakeitimus, iš naujo paleiskite rašybos ir gramatikos tikrintuvą ir paprašykite, kad kažkas perskaitytų / redaguotų dokumentą.
Įvedę bet kokius redaktoriaus atliktus pakeitimus, jūs paprastai baigsite (nebent jūsų įmonė turi oficialų dokumentų išleidimo procesą, kurio turėtumėte laikytis).
Atkreipkite dėmesį, kad dalyko ekspertų ir redaktoriaus atlikti pakeitimai (dalyko eksportavimas pagal tikslią formuluotę ir stilių) turėtų būti priimami beveik be abejonės: jų žinoti savo kompetencijos sritį. Jei tu stipriai nesutikti su pakeitimu, tik tada apie tai atkreipkite MVĮ ar redaktoriaus dėmesį. Kitu atveju atlikite siūlomus pakeitimus.
Patikrinkite savo instrukcijas naudojimu
Kai turėsite labai gerą juodraštį, įdarbinkite kelis žmones, kad patikrintumėte jūsų nurodymus - juos peržiūrėtumėte nuo pradžios iki galo ir pažymėkite (ir leiskite jums atkreipti dėmesį) į visas sritis, kuriose jie pasimeta ar supainiojami arba kur neteisingos instrukcijos.
Geriausia, jei tinkamumo naudoti bandytojai turėtų būti tikri jūsų dokumentuoto produkto / svetainės klientai / vartotojai. Vis dėlto įdarbinant kelis žmones iš viso biuro, kurie nėra susipažinę su tuo, ką parašėte, ir priversti juos išbandyti dokumentą, geriau nei nieko. Šiuo atveju atkreipkite dėmesį, kad testuotojai yra dalyko ekspertai, todėl jų pakeitimai yra tokie pat vertingi, kaip ir jūsų produkto MVĮ ir redaktoriaus (MVĮ).
Pats naudingumo testavimas yra visa disciplina, kuri yra per plati, kad ją būtų galima aptarti šiame straipsnyje.
Tačiau atlikę tinkamumo testavimo pakeitimus, atlikite pakeitimus redaktoriuje ir, jei taikoma, savo produkto / paslaugos MVĮ: galbūt nedidelis produkto / paslaugos pakeitimas dabar arba būsimame leidime turėtų didžiulį pokytį vartotojams.
Išvados ir apibendrinimai
Apie programinės įrangos instrukcijų rašymą galime padaryti šias išvadas ir apibendrinimus:
- Skaitytojai yra nusivylę, kai skaito jūsų darbą.
- Jums reikia palengvinti skaitytoją pasakojant, kur jie yra, ką daryti ir kur jie atsidurs.
- Jums reikia, kad ekspertai peržiūrėtų jūsų dokumentą dėl produkto tikslumo ir rašymo tikslumo.
- Turite sutikti su ekspertų atliktais pakeitimais, nebent jūs žymiai nesutinku, tokiu atveju kalbėkitės su šiuo ekspertu.
- Naudingumo testavimas yra geriausias būdas įsitikinti, kad jūsų dokumentas bus sėkmingas patenkinant vartotojų / skaitytojų poreikius. Tai gali net paskatinti produktą patobulinti!
Šis straipsnis yra tikslus ir tikras, kiek autorius žino. Turinys skirtas tik informaciniams ar pramoginiams tikslams ir nepakeičia asmeninių ar profesionalių patarimų verslo, finansų, teisiniais ar techniniais klausimais.
