Бағдарлама жасақтамасын құжаттау немесе бағдарлама кодін құжаттау компьютер бағдарламасын құжаттайтын текст. Бұл текст әр қызметтегі адамға әр түрлі мән беруі мүмкін, негізгі қызметі бағдарламалық жасақтаманың мақсаты мен қалай жұмыс істейтінін түсіндіреді.
Құжаттаудың бағдарлама жасақтамасын жасаудағы рөлі
Құжаттау бағдарламалық жасақтама жасаудың ең маңызды қадамдарының бірі саналады, оған:
- Талаптары (Requirements) – бағдарламалық жасақтама аттрибуттарын, мүмкіндіктерін, сипаттамаларын, және қасиеттірін түсіндіретін мәлімдемелер жинағы.
- Ахитектура/Дизайн (Architecture/Design) – Бағдарламалық жасақтаманы жалпылай қарап шығу. Бағдарламалық жасақтама компоненттерінің дизайнын жасауға арналған мәліметтер, ең алдымен қоршаған ортасы және құрастыру/конструкция принциптеріне негізделген.
- Техникалық (Technical) – Кодтарды, алгоритмдерді, интерфейстер және API ларды құжаттау.
- Қолданушы (End User) – Қолданушыға арналған нұсқаулар, жүйе администраторлары және system administrators and қолдаушы демеуші персоналға арналған.
- Маркетинг (Marketing) – Жасалынған өнімді сату және нарық жөнінде анализ жасау.
Талаптар құжаттамасы
Архитектура/Дизайн құжаттамасы
Техникалық құжаттау
Қолданушы құжаттамасы
Жазбалар
Тағы қараңыз
Сыртқы сілтемелер
- kelp - a source code annotation framework for architectural, design and technical documentation.
- automated software documentation Мұрағатталған 26 маусымның 2012 жылы. - application documentation
- ISO documentation standards committee - International Organization for Standardization committee which develops user documentation standards.
уикипедия, wiki, кітап, кітаптар, кітапхана, мақала, оқу, жүктеу, тегін, тегін жүктеу, mp3, видео, mp4, 3gp, jpg, jpeg, gif, png, сурет, музыка, ән, фильм, кітап, ойын, ойындар, ұялы, андроид, iOS, apple, ұялы телефон, samsung, iphone, xiomi, xiaomi, redmi, honor, oppo, nokia, sonya, mi, ДК, веб, компьютер
Bagdarlama zhasaktamasyn kuzhattau nemese bagdarlama kodin kuzhattau kompyuter bagdarlamasyn kuzhattajtyn tekst Bul tekst әr kyzmettegi adamga әr tүrli mәn berui mүmkin negizgi kyzmeti bagdarlamalyk zhasaktamanyn maksaty men kalaj zhumys istejtinin tүsindiredi Қuzhattaudyn bagdarlama zhasaktamasyn zhasaudagy roliҚuzhattau bagdarlamalyk zhasaktama zhasaudyn en manyzdy kadamdarynyn biri sanalady ogan Talaptary Requirements bagdarlamalyk zhasaktama attributtaryn mүmkindikterin sipattamalaryn zhәne kasiettirin tүsindiretin mәlimdemeler zhinagy Ahitektura Dizajn Architecture Design Bagdarlamalyk zhasaktamany zhalpylaj karap shygu Bagdarlamalyk zhasaktama komponentterinin dizajnyn zhasauga arnalgan mәlimetter en aldymen korshagan ortasy zhәne kurastyru konstrukciya principterine negizdelgen Tehnikalyk Technical Kodtardy algoritmderdi interfejster zhәne API lardy kuzhattau Қoldanushy End User Қoldanushyga arnalgan nuskaular zhүje administratorlary zhәne system administrators and koldaushy demeushi personalga arnalgan Marketing Marketing Zhasalyngan onimdi satu zhәne naryk zhoninde analiz zhasau Talaptar kuzhattamasy Arhitektura Dizajn kuzhattamasy Tehnikalyk kuzhattau Қoldanushy kuzhattamasyZhazbalarTagy karanyzBagdarlamalyk zhasaktama UMLSyrtky siltemelerkelp a source code annotation framework for architectural design and technical documentation automated software documentation Muragattalgan 26 mausymnyn 2012 zhyly application documentation ISO documentation standards committee International Organization for Standardization committee which develops user documentation standards