Мазмұны:
Бейне: Бастапқы код құжаттамасы дегеніміз не?
2024 Автор: Lynn Donovan | [email protected]. Соңғы өзгертілген: 2023-12-15 23:49
Бағдарламалық қамтамасыз ету құжаттама компьютерлік бағдарламалық жасақтамамен бірге немесе ішіне енгізілген жазбаша мәтін немесе иллюстрация бастапқы код . The құжаттама бағдарламалық құралдың қалай жұмыс істейтінін немесе оны қалай пайдалану керектігін түсіндіреді және әртүрлі рөлдегі адамдарға әртүрлі мағына беруі мүмкін. Архитектура/дизайн – бағдарламалық құралға шолу.
Осыны ескере отырып, құжаттарды қалай кодтайсыз?
Құжаттарды жазудың ең жақсы тәжірибелері:
- Құрамында README файлын қосыңыз.
- Басқалар үшін мәселені бақылау құралына рұқсат беріңіз.
- API құжаттамасын жазыңыз.
- Кодыңызды құжаттаңыз.
- Кодтау конвенцияларын қолданыңыз, мысалы, файлды ұйымдастыру, түсініктемелер, атау конвенциялары, бағдарламалау тәжірибесі және т.б.
- Қатысушыларға арналған ақпаратты қосыңыз.
Сондай-ақ, пайдаланушы құжаттамасы дегеніміз не? Пайдаланушы құжаттамасы -ге сілтеме жасайды құжаттама соңғы пайдаланушыларға ұсынылатын өнім немесе қызмет үшін. The пайдаланушы құжаттамасы соңғы пайдаланушыларға өнімді немесе қызметті пайдалануға көмектесу үшін жасалған. Бұл жиі деп аталады пайдаланушы көмек. The пайдаланушы құжаттамасы тұтынушыға жеткізілетін жалпы өнімнің бөлігі болып табылады.
Осыны ескере отырып, құжаттаманың қандай түрлері бар?
Түрлері жүйенің құжаттама талаптарды қамтиды құжат , бастапқы код құжат , сапа кепілдігі құжаттама , бағдарламалық қамтамасыз ету архитектурасы құжаттама , шешім нұсқаулары және озық пайдаланушыларға арналған анықтамалық нұсқаулық. Түрлері пайдаланушының құжаттама оқу нұсқаулықтарын, пайдаланушы нұсқаулығын, шығарылым жазбаларын және орнату нұсқаулығын қамтиды.
Бағдарламалық жасақтаманың құжаттамасында не болуы керек?
Құжаттамаңызға не қосу керек
- бағдарламалық құралдың не істейтінін және қандай мәселені шешетінін түсіндіру.
- кодыңыз әдетте қолданылатын жағдайларды көрсететін мысал.
- кодқа және қателерді бақылау құралына сілтемелер.
- Жиі қойылатын сұрақтар және қолдау сұрау тәсілдері.
- бағдарламалық құралды орнату туралы нұсқаулар.
Ұсынылған:
Бастапқы жол дегеніміз не?
Бастапқы жол C және C++ бастапқы файлдары орналасқан каталогтарды көрсетеді. Барлық көзге қатысты пәрмендер жергілікті компьютердегі бастапқы файлдарға қатынасады. Бастапқы пәрмендерді пайдаланғыңыз келетін кез келген клиентте немесе серверде дұрыс жолдарды орнатуыңыз керек
Ашық бастапқы код тегін бе?
Ашық бастапқы бағдарламалық жасақтаманың барлығы дерлік тегін бағдарламалық құрал болып табылады, бірақ ерекше жағдайлар бар. Біріншіден, кейбір ашық бастапқы лицензиялар тым шектеулі, сондықтан олар тегін лицензиялар санатына жатпайды. Мысалы, «Open Watcom» тегін емес, себебі оның лицензиясы өзгертілген нұсқаны жасауға және оны жеке пайдалануға мүмкіндік бермейді
Зерттеудегі бастапқы деректер дегеніміз не?
Бастапқы деректер – зерттеуші сауалнамалар, сұхбаттар немесе эксперименттер сияқты әдістерді қолдана отырып, бірінші көздерден жинайтын деректер. Ол ғылыми жобаны ескере отырып, тікелей бастапқы көздерден жиналады. Термин екіншілік деректер терминінен айырмашылығы қолданылады
Бастапқы кілттер және сыртқы кілттер дегеніміз не?
Бастапқы кілт пен сыртқы кілт қатынасы. Бастапқы кілт реляциялық дерекқор кестесіндегі жазбаны бірегей түрде анықтайды, ал сыртқы кілт басқа кестенің негізгі кілті болып табылатын кестедегі өріске сілтеме жасайды
Ашық бастапқы код пен ақысыз бағдарламаның айырмашылығы неде?
Әдетте, ақысыз бағдарламалық жасақтама ешқандай шығынсыз пайдалануға болатын бағдарламалық құралды білдіреді. Ашық бастапқы бағдарламалық жасақтама мен тегін бағдарламалық жасақтамадан айырмашылығы, ақысыз бағдарлама соңғы пайдаланушыға минималды еркіндік ұсынады. Осылайша, тегін бағдарламалық құрал көбінесе бастапқы кодын қоспай ортақ пайдаланылады, бұл ашық бастапқы бағдарламалық жасақтамаға немесе тегін бағдарламалық құралға тән емес