Forրագրի համար փաստաթղթեր պատրաստելու հեշտ եղանակներ. 12 քայլ

Բովանդակություն:

Forրագրի համար փաստաթղթեր պատրաստելու հեշտ եղանակներ. 12 քայլ
Forրագրի համար փաստաթղթեր պատրաստելու հեշտ եղանակներ. 12 քայլ

Video: Forրագրի համար փաստաթղթեր պատրաստելու հեշտ եղանակներ. 12 քայլ

Video: Forրագրի համար փաստաթղթեր պատրաստելու հեշտ եղանակներ. 12 քայլ
Video: ✅Настойка на фисташковой скорлупе 2024, Երթ
Anonim

Այս wikiHow- ը սովորեցնում է ձեզ, թե ինչպես գրել փաստաթղթեր բաց կոդով նախագծի համար: Այս փաստաթղթերը սովորաբար կոչվում են README ֆայլ: README- ը տեքստային կամ HTML փաստաթուղթ է, որը պարունակում է կարևոր տեղեկություններ ինչպես ծրագրի, այնպես էլ օգտագործողների համար:

Քայլեր

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 1
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 1

Քայլ 1. Գրեք ձեր նախագծի վերնագիրը:

Ձեր նախագծի համար README գրելիս առաջին բանը, որ պետք է ներառեք, ծրագրի վերնագիրն է: Վերնագրի հետ մեկտեղ պետք է ներառեք նաև վերջին տարբերակի համարը և վերջին թարմացման ամսաթիվը:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 2
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 2

Քայլ 2. Գրեք ձեր նախագծի նկարագրությունը:

Հաջորդ բանը, որ դուք պետք է ներառեք ձեր README- ում, ձեր նախագծի համառոտ նկարագրությունն է: Բացատրեք, թե ինչ է անում նախագիծը, ինչու է այն գոյություն ունի և ինչ խնդիրներ է լուծում: Կարող եք նաև ներառել ցանկացած հատուկ գործառույթ, սքրինշոթ, կոդի ոճ, տեխնոլոգիա կամ օգտագործված շրջանակ, կամ որևէ այլ բան, որը օգտակար կլինի օգտվողներին և մշակողներին:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 3
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 3

Քայլ 3. Բացատրեք ձեր նախագծի ցանկացած պահանջ:

Եթե ձեր նախագիծը պատշաճ գործարկելու համար անհրաժեշտ է որևէ հատուկ պահանջ, համոզվեք, որ նշեք այդ պահանջներն ու հրահանգները կամ դրանց տեղադրման հրահանգների հղումը:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 4
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 4

Քայլ 4. Ներառեք ծածկագրի օրինակ:

Տվեք հստակ և հակիրճ օրինակ, թե ինչի համար է օգտագործվում ձեր նախագիծը: Կոդը պետք է հեշտ լինի պարզել մշակողների համար, և API- ն պետք է հստակ տեսանելի լինի:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 5
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 5

Քայլ 5. Տրամադրեք տեղադրման հրահանգներ:

Բացատրեք օգտվողներին, թե ինչպես կարելի է ձեր ծրագրակազմը գործարկել քայլ առ քայլ ձևաչափով: Ձեր ցուցումները պետք է հնարավորինս հստակ լինեն: Ենթադրենք, որ ձեր օգտվողները չունեն ծրագրային ապահովման մշակման կամ համակարգի կառավարման մասին գիտելիքներ:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 6
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 6

Քայլ 6. Բացատրեք, թե ինչպես օգտագործել ծրագրակազմը:

Ասացեք մարդկանց, թե ինչպես առավելագույն օգուտ քաղել ձեր ծրագրակազմից: Տրամադրեք քայլ առ քայլ հրահանգներ, թե ինչպես օգտագործել ձեր ծրագրաշարը, ինչպես նաև տարբեր կազմաձևման տարբերակներ և ինչպես դրանք սահմանել:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 7
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 7

Քայլ 7. Ասացեք օգտվողներին, թե ինչպես ստանալ տեխնիկական աջակցություն:

Տրամադրում է հղումներ դեպի ցանկացած փոստային հասցեների, IRC ալիքների կամ համայնքային ֆորումների, որոնց օգտվողները կարող են դիմել տեխնիկական աջակցության համար: Նաև տեղեկացրեք ավելի փորձառու օգտվողներին, թե որտեղ պետք է ներկայացնեն սխալներ և գաղափարներ `նախագիծն ավելի լավը դարձնելու համար:

Եթե գտնում եք, որ տարբեր օգտվողներից ստանում եք միևնույն հարցերը, գուցե ցանկանաք ներառել ՀՏՀ (հաճախ տրվող հարցեր) ՝ որպես ծրագրի փաստաթղթերի մի մաս:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 8
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 8

Քայլ 8. Բացատրեք, թե ինչպես նպաստել:

Եթե աշխատում եք բաց կոդով նախագծի վրա, տեղեկացրեք ձեր օգտվողներին, թե ինչպես կարող են նպաստել ձեր նախագծին: Բացատրեք ձեր ունեցած ցանկացած չափանիշ և տրամադրեք որոշ ուղեցույցներ պոտենցիալ ներդրողներին:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 9
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 9

Քայլ 9. Թվարկեք վարկերը:

Միշտ վարկ տվեք այնտեղ, որտեղ պետք է վարկ լինի: Համոզվեք, որ նշեք բոլոր մասնակիցների անունները, ինչպես նաև երրորդ կողմի գրադարանների կամ ծրագրերի հղումները, որոնք դուք կարող եք օգտագործել: Ներառեք հղումներ ցանկացած ոգեշնչման, որը դուք կարող էիք ունենալ ձեր նախագիծը կառուցելիս:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 10
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 10

Քայլ 10. Ներկայացրեք ձեր կոնտակտային տվյալները:

Մարդիկ կարող են ցանկանալ կապ հաստատել ձեզ հետ ցանկացած պատճառով: Համոզվեք, որ տրամադրեք վավեր էլփոստի հասցե, որը մարդիկ կարող են օգտագործել ձեզ հետ կապ հաստատելու համար:

Որոշ երկրներ օրենքով կարող են պահանջել լրացուցիչ տեղեկատվություն, օրինակ ՝ փոստային հասցե կամ ընկերության անուն:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 11
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 11

Քայլ 11. Տրամադրել լիցենզիայի մասին տեղեկություններ:

Օգտվողների համար կարևոր է իմանալ, թե ինչպես է ձեր նախագիծը լիցենզավորվում: Համացանցում կան բազմաթիվ ստանդարտ լիցենզիաներ, որոնք կարող եք օգտագործել: Բացատրեք, թե ինչ լիցենզիա է օգտագործում ձեր նախագիծը, ինչպես նաև ցանկացած երրորդ կողմի գրադարանների կամ ծրագրերի լիցենզիաները, որոնք կարող եք օգտագործել:

Ձեզ անհրաժեշտ չէ բացատրել ամբողջ լիցենզիան ձեր փաստաթղթերում: Պարզապես տեղեկացրեք օգտվողներին, թե ինչ լիցենզիա է օգտագործում ձեր նախագիծը և հղում տրամադրեք ամբողջական լիցենզիայի տեղեկատվությանը:

Preրագրի համար փաստաթղթերի պատրաստում Քայլ 12
Preրագրի համար փաստաթղթերի պատրաստում Քայլ 12

Քայլ 12. Թվարկեք նախագծի բոլոր տարբերակները:

Համոզվեք, որ ստեղծեք ձեր նախագծի բոլոր նախորդ տարբերակների ցուցակ և գրեք համառոտ նկարագրություն, թե ինչ փոփոխություններ եք կատարել յուրաքանչյուր տարբերակի համար:

Խորհուրդներ

  • Լավ պրակտիկա է սկսել նախապատրաստել ձեր README ֆայլը, նախքան ձեր նախագիծը մշակելը: Սա կօգնի ձեզ մտածել ձեր ծրագրի և այն, ինչ ձեզ հարկավոր է հասնել: Դա կօգնի ձեզ մշակել ուղեցույցներ, որոնք կարող եք հաղորդել այլ մասնակիցների, և դուք ավելի մոտիվացված կլինեք գրել ձեր README ֆայլը ձեր ծրագրի սկզբում:
  • Համոզվեք, որ ձեր նախագծի վրա աշխատելիս հաճախակի եք թարմացնում README ֆայլը և այլ փաստաթղթեր:
  • Եթե README ֆայլը մեկ էջից ավելի երկար է, կարող եք առանձին բաժին գրել ավելի երկար բաժիններ, ինչպիսիք են տեղադրման հրահանգները, օգտագործողի ուղեցույցը և ՀՏՀ -ն: Համոզվեք, որ ստեղծեք բովանդակության աղյուսակ ձեր բոլոր նախագծային փաստաթղթերի համար և հղում տվեք README ֆայլում առկա համապատասխան փաստաթղթերին:

Խորհուրդ ենք տալիս: