Pavarësisht se sa i zgjuar mund të jetë një shpikës, programues ose racionalizues, ndonjëherë krijimet e tij thjesht nuk mund të përdoren për qëllimin e tyre të synuar. Arsyeja për këtë është manuali i hartuar gabimisht i udhëzimeve ose mungesa e plotë e tij. Por edhe shpikësit e zgjuar ndonjëherë shkruajnë udhëzime të tilla që, përveç specialistëve të ngushtë, askush nuk mund t'i lexojë këto letra. Atëherë, si e hartoni si duhet një dokument kaq të nevojshëm?
Është e nevojshme
- - njohuri njëqind për qind e pajisjes ose produktit softuer për të cilin po shkruhet manuali;
- - njohuri në fushën e gjuhësisë;
- - aftesite e te shkruarit.
Udhëzimet
Hapi 1
Një manual përdorimi ose, me fjalë të tjera, një manual operacioni është një dokument i krijuar për të siguruar ndihmë në përdorimin e një sistemi të caktuar për përdoruesit e tij. Për të përpiluar një manual përdorimi, duhet të njihni sistemin e përshkruar njëqind për qind, por shikojeni atë me sytë e një studenti injorant. Supozoni se një manual përdorimi është shkruar për një program softuer që ende nuk ka analoge. Imagjinoni se kjo është hera juaj e parë që përdorni këtë program. Ku e filloni Cila është gjëja e parë që dihet? Organizoni këtë njohuri në kategori me rëndësi.
Hapi 2
Duke ndarë të gjitha informacionet në lidhje me krijimin tuaj në grupe, ju keni hartuar një plan për të shkruar një manual përdorimi. Filloni të përshkruani punën në programin tuaj nga e para, duke lënë për të fundit detajet më të vështira, siç janë tiparet e riprogramimit ose trajtimin e gabimeve kritike. Në këtë fazë, duhet të keni gati përmbajtjen e manualit të përdoruesit - një nga pjesët e kërkuara të këtij dokumenti.
Hapi 3
Nëse manuali që po krijoni ka për qëllim të përdoret në një kompani të madhe, atëherë duhet t'i kushtoni vëmendje standardeve të korporatave të miratuara atje. Për shembull, në shumë kompani ruse, manualet e përdorimit nuk pranohen pa mbështetje ilustruese, me fjalë të tjera, fotografi që shpjegojnë atë që është shkruar. Përveç përmbajtjes, manuali i përdoruesit duhet të përmbajë pjesë të tjera të detyrueshme: - Shënim, domethënë, një shpjegim i objektivave të përgjithshëm të manualit dhe produktit të përshkruar; - një hyrje, e cila përshkruan dokumentet në lidhje me manualin e përdorimit dhe si për të përdorur manualin; - pjesët që shpjegojnë përdorimin e produktit në faza të ndryshme të përdorimit të tij, për shembull, hapat e parë, riparimi ose mirëmbajtja; - seksioni i pyetjeve dhe përgjigjeve të bëra shpesh; - fjalori ose indeksi i temës.
Hapi 4
Zakonisht, një shkrimtar teknik është i përfshirë në krijimin e një manuali përdorimi - një person i cili ka të gjitha njohuritë e nevojshme si në gjuhë ashtu edhe në produktin që përshkruhet. Si një shkrimtar teknik pa trajnim, duhet të mbani mend disa rregulla. Së pari, ju nuk duhet të abuzoni me terma të veçantë që nuk janë të kuptueshëm për një përdorues të zakonshëm. Së dyti, secili term i përdorur duhet të jetë i detajuar dhe i shpjeguar. Së treti, duhet të shkruani sa më qartë dhe në mënyrë koncize. Së fundmi, një shkrimtar teknik duhet të jetë në gjendje të shikojë tekstin e tij përmes syve të një përdoruesi të zakonshëm në mënyrë që të shohë mangësitë e tekstit të tyre.
Hapi 5
Goodshtë mirë që të provohet teksti i përfunduar i manualit të përdorimit në praktikë duke ia ofruar një personi i cili nuk kishte asnjë lidhje me produktin e përshkruar. Me përpjekje të përbashkëta, është e mundur të eliminohen të gjitha mangësitë dhe kurthet e dokumentit.
