Бағдарлама жасақтамасын құжаттау

Бағдарлама жасақтамасын құжаттау немесе бағдарлама кодін құжаттау компьютер бағдарламасын құжаттайтын текст. Бұл текст әр қызметтегі адамға әр түрлі мән беруі мүмкін, негізгі қызметі бағдарламалық жасақтаманың мақсаты мен қалай жұмыс істейтінін түсіндіреді.

Құжаттаудың бағдарлама жасақтамасын жасаудағы рөлі

Құжаттау бағдарламалық жасақтама жасаудың ең маңызды қадамдарының бірі саналады, оған:

1. Талаптары (Requirements) - бағдарламалық жасақтама аттрибуттарын, мүмкіндіктерін, сипаттамаларын, және қасиеттірін түсіндіретін мәлімдемелер жинағы.
2. Ахитектура/Дизайн (Architecture/Design) - Бағдарламалық жасақтаманы жалпылай қарап шығу. Бағдарламалық жасақтама компоненттерінің дизайнын жасауға арналған мәліметтер, ең алдымен қоршаған ортасы және құрастыру/конструкция принциптеріне негізделген.
3. Техникалық (Technical) - Кодтарды, алгоритмдерді, интерфейстер және API ларды құжаттау.
4. Қолданушы (End User) - Қолданушыға арналған нұсқаулар, жүйе администраторлары және system administrators and қолдаушы демеуші персоналға арналған.
5. Маркетинг (Marketing) - Жасалынған өнімді сату және нарық жөнінде анализ жасау.

Тағы қараңыз

• Бағдарламалық жасақтама
• API Writer
• Comparison of documentation generators
• Design by contract
• Docstring
• Documentation
• User Assistance
• Design document
• README files
• Unified Modeling Language UML
• Literate programming

Сыртқы сілтемелер

• kelp - a source code annotation framework for architectural, design and technical documentation.
• automated software documentation - application documentation
• ISO documentation standards committee - International Organization for Standardization committee which develops user documentation standards.