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

Ի՞նչ է սկզբնական ծածկագրի փաստաթղթերը:
Ի՞նչ է սկզբնական ծածկագրի փաստաթղթերը:

Video: Ի՞նչ է սկզբնական ծածկագրի փաստաթղթերը:

Video: Ի՞նչ է սկզբնական ծածկագրի փաստաթղթերը:
Video: Վերագործարկվել է Կադաստրի կատարելագործված էլեկտրոնային հարթակը 2024, Ապրիլ
Anonim

Ծրագրային ապահովում փաստաթղթեր գրված տեքստ կամ նկարազարդում է, որն ուղեկցում է համակարգչային ծրագրերին կամ ներկառուցված է դրանում աղբյուր կոդը . Այն փաստաթղթեր կամ բացատրում է, թե ինչպես է աշխատում ծրագրաշարը կամ ինչպես օգտագործել այն, և կարող է տարբեր նշանակություն ունենալ տարբեր դերերում գտնվող մարդկանց համար: Ճարտարապետություն/Դիզայն – Ծրագրային ապահովման ակնարկ:

Հաշվի առնելով սա՝ ինչպե՞ս եք կոդավորում փաստաթղթերը:

Փաստաթղթեր գրելու լավագույն փորձը

  1. Ներառեք README ֆայլ, որը պարունակում է:
  2. Թույլատրել խնդիրների հետագծումը ուրիշների համար:
  3. Գրեք API փաստաթուղթ:
  4. Փաստաթղթավորեք ձեր կոդը:
  5. Կիրառեք կոդավորման կոնվենցիաներ, ինչպիսիք են ֆայլերի կազմակերպումը, մեկնաբանությունները, անվանման կոնվենցիաները, ծրագրավորման պրակտիկաները և այլն:
  6. Ներառեք տեղեկություններ ներդրողների համար:

Կարելի է նաև հարցնել՝ ի՞նչ է օգտատիրոջ փաստաթղթերը։ Օգտագործողի փաստաթղթեր վերաբերում է փաստաթղթեր վերջնական օգտագործողներին տրամադրվող ապրանքի կամ ծառայության համար: Այն օգտագործողի փաստաթղթեր նախատեսված է վերջնական օգտագործողներին օգնելու օգտագործել ապրանքը կամ ծառայությունը: Սա հաճախ կոչվում է որպես օգտագործող օգնություն։ Այն օգտագործողի փաստաթղթեր հաճախորդին առաքվող ընդհանուր արտադրանքի մի մասն է:

Հաշվի առնելով սա, որո՞նք են փաստաթղթերի տեսակները:

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

Ի՞նչ պետք է ներառվի ծրագրային փաստաթղթերում:

Ինչ ներառել ձեր փաստաթղթում

  1. բացատրություն, թե ինչ է անում ձեր ծրագրաշարը և ինչ խնդիր է լուծում:
  2. օրինակ, որը ցույց է տալիս այն հանգամանքները, որոնցում սովորաբար կօգտագործվի ձեր կոդը:
  3. հղումներ կոդի և սխալների հետագծման համար:
  4. ՀՏՀ և աջակցություն խնդրելու ուղիներ:
  5. հրահանգներ, թե ինչպես տեղադրել ձեր ծրագրաշարը:

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