Softwareրագրային ապահովման լավ փաստաթղթերը, լինի դա ծրագրավորողների և փորձարկողների համար նախատեսված տեխնիկական փաստաթղթեր, ներքին օգտվողների համար նախատեսված տեխնիկական փաստաթղթեր, կամ ձեռնարկներ և ֆայլեր վերջնական օգտագործողների համար, կօգնեն օգտվողներին հասկանալ ծրագրաշարի առանձնահատկություններն ու գործառույթները: Լավ փաստաթղթերը փաստաթղթեր են, որոնք հստակ, հստակ և տեղին են ՝ օգտագործողի համար անհրաժեշտ բոլոր տեղեկություններով: Այս հոդվածը կառաջնորդի ձեզ գրել տեխնիկական և վերջնական օգտագործողների համար ծրագրային ապահովման փաստաթղթեր:
Քայլ
Մեթոդ 1 -ը ՝ 2 -ից. Softwareրագրային փաստաթղթեր գրել տեխնիկական օգտագործողների համար
Քայլ 1. Իմացեք, թե ինչ տեղեկատվություն պետք է ներառել:
Տեխնիկական փաստաթուղթը օգտագործվում է որպես տեղեկատու ձեռնարկ `ինտերֆեյսի դիզայներների, ծածկագիր գրող ծրագրավորողների և ծրագրավորողի աշխատանքը ստուգող փորձարկողների համար: Տեղեկատվությունը, որը պետք է ներառվի, կախված կլինի ստեղծվող ծրագրից, բայց կարող է ներառել հետևյալը.
- Հավելվածի կարևոր ֆայլերը, ինչպիսիք են մշակման թիմի ստեղծած ֆայլերը, ծրագրի գործարկման ընթացքում մուտք գործված տվյալների շտեմարանները և երրորդ կողմի ծրագրեր:
- Գործառույթներ և ենթածրագրեր, ներառյալ գործառույթի/ենթածրագրի, մուտքի և ելքի արժեքների օգտագործման բացատրությունը:
- Programրագրի փոփոխականներ և հաստատուններ, և ինչպես են դրանք օգտագործվում:
- Programրագրի ընդհանուր կառուցվածքը: Սկավառակի վրա հիմնված ծրագրերի համար կարող է անհրաժեշտ լինել նկարագրել յուրաքանչյուր մոդուլ և գրադարան: Կամ, եթե դուք վեբ ծրագրով ձեռնարկ եք գրում, գուցե անհրաժեշտ լինի բացատրել, թե որ ֆայլերն է օգտագործում յուրաքանչյուր էջ:
Քայլ 2. Որոշեք, թե ինչ մակարդակի փաստաթղթեր պետք է ներկա լինեն և առանձնացվեն ծրագրի ծածկագրից:
Որքան շատ տեխնիկական փաստաթղթեր ներառվեն ծրագրի ծածկագրում, այնքան ավելի հեշտ կլինի այն թարմացնել և պահպանել, ինչպես նաև բացատրել ծրագրի տարբեր տարբերակները: Codeրագրի ծածկագրում փաստաթղթերը պետք է ներառեն առնվազն գործառույթների, ենթածրագրերի, փոփոխականների և հաստատունների օգտագործումը:
- Եթե ձեր աղբյուրի ծածկագիրը երկար է, կարող եք փաստաթղթեր գրել օգնության ֆայլում, որը կարող է ինդեքսավորվել կամ որոնվել որոշակի հիմնաբառերով: Փաստաթղթերի առանձին ֆայլերը օգտակար են, եթե ծրագրի տրամաբանությունը բաժանված է մի քանի էջի և ներառում է օժանդակ ֆայլեր, օրինակ ՝ վեբ ծրագիր:
- Որոշ ծրագրավորման լեզուներ (օրինակ ՝ Java, Visual Basic. NET կամ C#) ունեն իրենց կոդերի փաստաթղթավորման ստանդարտները: Նման դեպքերում հետևեք ստանդարտ փաստաթղթերին, որոնք պետք է ներառվեն աղբյուրի կոդի մեջ:
Քայլ 3. Ընտրեք համապատասխան փաստաթղթավորման գործիքը:
Որոշ դեպքերում փաստաթղթավորման գործիքը որոշվում է օգտագործվող ծրագրավորման լեզվով: C ++, C#, Visual Basic, Java, PHP և այլ լեզուներն ունեն իրենց փաստաթղթավորման գործիքները: Այնուամենայնիվ, եթե ոչ, ապա օգտագործվող գործիքները կախված կլինեն պահանջվող փաստաթղթերից:
- Բառի մշակողը, ինչպիսին է Microsoft Word- ը, հարմար է փաստաթղթերի տեքստային ֆայլեր ստեղծելու համար, քանի դեռ փաստաթղթերը հակիրճ և պարզ են: Բարդ տեքստով երկար փաստաթղթեր ստեղծելու համար տեխնիկական գրողների մեծ մասն ընտրում է փաստաթղթավորման մասնագիտացված գործիք, ինչպիսին է Adobe FrameMaker- ը:
- Աղբյուրի ծածկագրման համար օգնության ֆայլերը կարող են ստեղծվել օժանդակ ֆայլերի ստեղծման ծրագրով, ինչպիսիք են RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare կամ HelpLogix:
Մեթոդ 2 2 -ից. Softwareրագրային փաստաթղթերի գրում վերջնական օգտագործողների համար
Քայլ 1. Իմացեք ձեռնարկի ստեղծման հիմքում ընկած բիզնես պատճառները:
Թեև ծրագրային փաստաթղթերի ստեղծման հիմնական պատճառն այն է, որ օգտագործողները հասկանան, թե ինչպես օգտագործել ծրագիրը, կան մի քանի այլ պատճառներ, որոնք կարող են հիմք հանդիսանալ փաստաթղթերի ստեղծման համար, ինչպիսիք են ՝ շուկայավարման բաժնին օգնել վաճառել ծրագիրը, բարելավել ընկերության իմիջը և նվազեցնել տեխնիկական աջակցությունը: ծախսերը: Որոշ դեպքերում փաստաթղթերը պահանջվում են կանոնակարգերին կամ այլ իրավական պահանջներին համապատասխանելու համար:
Այնուամենայնիվ, փաստաթղթերը ինտերֆեյսի լավ փոխարինող չեն: Եթե դիմումը պահանջում է բազմաթիվ փաստաթղթեր գործելու համար, այն պետք է նախագծված լինի ավելի ինտուիտիվ:
Քայլ 2. Իմացեք փաստաթղթերի թիրախային լսարանը:
Ընդհանրապես, ծրագրակազմի օգտագործողները համակարգչային սահմանափակ գիտելիքներ ունեն իրենց կողմից օգտագործվող ծրագրերից դուրս: Փաստաթղթերի կարիքները բավարարելու մի քանի եղանակ կա.
- Ուշադրություն դարձրեք ծրագրակազմի օգտագործողի կոչմանը: Օրինակ, համակարգի ադմինիստրատորը հիմնականում հասկանում է տարբեր համակարգչային ծրագրեր, մինչդեռ քարտուղարը գիտի միայն այն ծրագրերը, որոնցով նա օգտագործում է տվյալներ մուտքագրելու համար:
- Ուշադրություն դարձրեք ծրագրակազմի օգտագործողներին: Չնայած նրանց դիրքերն ընդհանուր առմամբ համատեղելի են կատարված առաջադրանքների հետ, այդ պաշտոնները կարող են ունենալ տարբեր ծանրաբեռնվածություններ ՝ կախված բիզնեսի վայրից: Հարցազրույցներ անցկացնելով պոտենցիալ օգտվողների հետ ՝ կարող եք պարզել, թե արդյոք նրանց աշխատանքի կոչման գնահատականը ճիշտ է:
- Ուշադրություն դարձրեք առկա փաստաթղթերին: Softwareրագրաշարի ֆունկցիոնալության փաստաթղթերը և բնութագրերը կարող են ցույց տալ, թե ինչ պետք է իմանան օգտվողները դրանք օգտագործելու համար: Այնուամենայնիվ, հիշեք, որ օգտվողներին կարող է հետաքրքրել ծրագրի «ներքինը» իմանալը:
- Իմացեք, թե ինչ է անհրաժեշտ առաջադրանքը կատարելու համար, և ինչ է այն տևում մինչև այն ավարտելը:
Քայլ 3. Որոշեք փաստաթղթերի համապատասխան ձևաչափը:
Softwareրագրային ապահովման փաստաթղթերը կարող են դասավորվել 1 կամ 2 ձևաչափով, այն է `տեղեկատու գրքեր և ձեռնարկներ: Երբեմն երկու ձևաչափերի համատեղումը լավ լուծում է:
- Հղման ձևաչափերն օգտագործվում են ծրագրաշարի բոլոր հնարավորությունները, օրինակ ՝ կոճակները, ներդիրները, դաշտերը և երկխոսության տուփերը նկարագրելու և դրանց աշխատանքի համար: Օգնության որոշ ֆայլեր գրված են այս ձևաչափով, հատկապես դրանք, որոնք ենթատեքստին զգայուն են: Երբ օգտագործողը որոշակի էկրանին սեղմում է Օգնության վրա, օգտվողը կստանա համապատասխան թեման:
- Ձեռնարկի ձևաչափը օգտագործվում է բացատրելու համար, թե ինչպես անել ինչ -որ բան ծրագրաշարի հետ: Ձեռնարկները հիմնականում տպագիր կամ PDF ձևաչափով են, չնայած որոշ օգնության էջեր պարունակում են նաև հրահանգներ, թե ինչպես անել որոշ բաներ: (Ընդհանրապես, ձեռքով ձևաչափերը ենթատեքստին զգայուն չեն, բայց կարող են կապված լինել համատեքստին զգայուն թեմաներից): Ձեռնարկներն, ընդհանուր առմամբ, ուղեցույցի տեսքով են `նկարագրության մեջ կատարվելիք խնդիրների ամփոփմամբ և քայլերով ձևակերպված ուղեցույցով:
Քայլ 4. Որոշեք փաստաթղթերի տեսակը:
Օգտագործողների համար ծրագրային փաստաթղթերը կարող են փաթեթավորված լինել հետևյալ ձևաչափերից մեկով կամ մի քանիսով ՝ տպագիր ձեռնարկներ, PDF ֆայլեր, օգնության ֆայլեր կամ առցանց օգնություն: Փաստաթղթերի յուրաքանչյուր տեսակ նախատեսված է ցույց տալու համար, թե ինչպես օգտագործել ծրագրաշարի գործառույթները ՝ լինի դա ուղեցույց, թե ձեռնարկ: Առցանց փաստաթղթերը և օգնության էջերը կարող են ներառել նաև ցուցադրական տեսանյութեր, տեքստ և ստատիկ պատկերներ:
Առցանց օգնության և աջակցության ֆայլերը պետք է ինդեքսավորվեն և որոնվեն հիմնաբառերի միջոցով, որպեսզի օգտվողները կարողանան արագ գտնել իրենց անհրաժեշտ տեղեկատվությունը: Թեև օգնության ֆայլ գեներացնող հավելվածը կարող է ինքնաբերաբար ինդեքս ստեղծել, այնուամենայնիվ խորհուրդ է տրվում, որ ինդեքս ստեղծեք ձեռքով ՝ օգտագործելով ընդհանուր որոնվող հիմնաբառերը:
Քայլ 5. Ընտրեք համապատասխան փաստաթղթավորման գործիքը:
Տպագիր ձեռնարկները կամ PDF- ները կարող են ստեղծվել տեքստերի մշակման ծրագրով, ինչպիսիք են Word- ը կամ առաջադեմ տեքստային խմբագիր, ինչպիսին է FrameMaker- ը ՝ կախված ֆայլի երկարությունից և բարդությունից: Օգնության ֆայլերը կարող են գրվել օգնության ֆայլերի ստեղծման ծրագրով, օրինակ ՝ RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix կամ HelpServer:
Խորհուրդներ
- Documentationրագրի փաստաթղթերի տեքստը պետք է կառուցված լինի այնպես, որ այն հեշտ ընթերցվի: Տեղադրեք պատկերը հնարավորինս համապատասխան տեքստին: Տրամաբանական բաժանել փաստաթղթերը ըստ բաժինների և թեմաների: Յուրաքանչյուր բաժին կամ թեմա պետք է բնութագրի որոշակի խնդիր ՝ ինչպես առաջադրանքի, այնպես էլ ծրագրի առանձնահատկությունները: Առնչվող խնդիրները կարող են բացատրվել հղումներով կամ տեղեկատու ցուցակներով:
- Այս հոդվածում նկարագրված փաստաթղթերից յուրաքանչյուրը կարող է լրացվել սքրինշոթ պատրաստող ծրագրով, օրինակ ՝ SnagIt- ով, եթե ձեր փաստաթղթերը պահանջում են բազմաթիվ սքրինշոթեր: Ինչպես ցանկացած այլ փաստաթղթեր, դուք նույնպես պետք է ներառեք սքրինշոթեր, որոնք կօգնեն բացատրել, թե ինչպես է աշխատում ծրագիրը, այլ ոչ թե օգտվողին «հրապուրել»:
- Ոճին ուշադրություն դարձնելը շատ կարևոր է, հատկապես, եթե դուք ծրագրային փաստաթղթեր եք գրում վերջնական օգտագործողների համար: «Օգտվող» -ի փոխարեն օգտվողներին հասցեագրեք «դու» դերանունը:
