33 группа. Учебная практика 2018: прикладное программирование, документация на ПО

1. Создайте учетную запись на веб-сервис для хостинга IT-проектов
GitHub, перейдите по ссылке https://github.com
2. Создайте новый репозиторий с названием Вашего проекта
или базы данных, например, parking, bookmarket, delo, autoservice
и т.п.
Пример: https://github.com/ifizmat/lazarus_mysql_simply-01

Оформление документации на программные средства

Изучите по источнику [4stud.info] пример содержания документации на программное обеспечение.
Tребованиям к содержанию документации на программное обеспечение по ГОСТ ЕСПД:

1. ГОСТ 34.602-89. Техническое задание (разрабатывается студентом самостоятельно на основе описания варианта задания)
2. ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению
3. ГОСТ 19.402-78 ЕСПД. Описание программы
4. ГОСТ 19.404-79 ЕСПД. Пояснительная записка
5. ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению
6. ГОСТ 19.301-78 ЕСПД. Программа и методика испытаний
7. ГОСТ 19.503-79 ЕСПД. Руководство системного программиста (системного администратора)
8. ГОСТ 19.504-79 ЕСПД. Руководство программиста
9. ГОСТ 19.505-79 ЕСПД. Руководство оператора (пользователя)

Минимальные требования к содержанию:

1. Введение (краткое описание предметной области для которой разработана программа)
2. Цель разработки
3. Обзор аналогов (3-4 подобных программы, информация о разработчике, описание возможностей, преимущества и недостатки)
4. Постановка задачи и требования, предъявляемые к программе
5. Описание алгоритма работы программы (текстовое и графическое (блок-схемы на уровне структурных компонентов — обязательно))
6. Выбор и обоснование выбора средства разработки, исходный код программы
7. Тестирование программы (описание методики тестирования, набор тестовых данных и результаты выполнения)
8. Руководство по установке
9. Руководство пользователя
10. Руководство администратора (если требуется)

3. Установите на вашем компьютере систему Git, например,
с помощью программы PortableGit
4. Выполните настройки Git.
Пример настроек

git config --global --list
git config --global user.name "myusername"
git config --global user.email "myusername.com"
git config --global core.autocrlf true
git config --global core.safecrlf true

6. Изучите методы работы с системой Git с помощью одного из источников [1, 2, 3] или других.
7. Выполните экспорт базы данных в формате SQL

Пример команды экспорта в папке сервера MySQL bin:
mysqldump -u root -p > database.sql

Пример команды импорта в папке сервера MySQL bin:
mysql -u root -p 
mysql>source D:/3kurs/database.sql

8. Перенесите в Ваш репозиторий на GitHub

• 8.1. Минимальный набор файлов исходного кода проекта.
• 8.2. Файл БД в формате SQL.
• 8.3. Исполнимый модуль программного проекта.
• 8.4. Файл с документацией в формате DOC MS Word 2003
• 8.5. Файл с презентацией в формате PPT MS PowerPoint 2003.

Пример

project1.lpi
project1.lpr
unit1.lfm
unit1.lrs
unit1.pas
project_database.exe
database.sql
Отчет.doc       (в формате MS Word 2003)
Презентация.ppt (в формате MS PowerPoint 2003)

9. В GitHub создайте в разделе Issues 5 сообщений о дефектах собственной программы и 5 сообщений о дефекте проекта одного из однокурсников по ссылке в блоге.

10. Поделитесь ссылкой на Ваш репозиторий в комментариях к блогу

1. 2018 год: 33 группа. Учебная практика 2018: прикладное программирование, документация на ПО
2. 2017 год: Учебная практика 2017: репозиторий GitHub
3. 2016 год: Учебная практика: репозиторий GitHub
4. 2015 год: Прикладное программирование: SVN Git

---

Источники

Основные

1. 4stud.info: Пример содержания документации на программное обеспечение
2. habrahabr.ru: Как начать работать с GitHub: быстрый старт
3. htmlstudio.ru: Git для начинающих. Краткое руководство
4. habrahabr.ru: Ежедневная работа с Git

Дополнительные

3. Git How To: курс обучения Git на русском