ГДiК_РГЗ_2014
.pdf21
Урозділі «Звертання до програми» повинно бути наведено опис процедур виклику програми (способи передачі управління та параметрів даних тощо).
Урозділі «Початкові та вихідні дані» повинно бути приведено опис організації початкової і вихідної інформації, що використовується, та за необхідності її кодування.
Урозділі «Повідомлення» повинно бути зазначено тексти повідомлень, які видаються програмісту чи оператору в процесі виконання програми, опис їхнього змісту та дії, які необхідно виконати за появи цих повідомлень.
Удодатку до керівництва програміста можуть бути наведені додаткові матеріали (приклади, ілюстрації, таблиці, графіки тощо).
2.2.6 Керівництво системного програміста
Згідно з ГОСТом 19.503–79 керівництво системного програміста повинно містити наступні розділи:
–загальні відомості про програму;
–структура програми;
–налаштування програми;
–перевірка програми;
–додаткові можливості;
–повідомлення системному програмісту.
У залежності від особливостей документу дозволяється об’єднувати окремі розділи або вводити нові.
В обґрунтованих випадках допускається розділ «Додаткові можливості» не приводити, а в неіменованих розділах опускати слово «програма» або заміщувати його на «найменування програми».
Урозділі «Загальні відомості про програму» повинно бути вказано призначення і функції програми та відомості про технічні та програмні засоби, що забезпечують виконання даної програми.
Урозділі «Структура програми» повинно бути наведено відомості про структуру програми, її складові частини, про зв’язки між складовими частинами та про зв’язки з іншими програмами.
Урозділі «Налаштування програми» повинно бути наведено опис дій з налаштування програми за умов конкретного використання (налаштування складу технічних засобів, вибору функцій тощо)
22
Урозділі «Перевірка програми» повинно бути наведено опис способів перевірки, які дозволяють зробити загальні висновки щодо працездатності програми (контрольні приклади, методи прогону, результати).
Урозділі «Додаткові можливості» повинно бути наведено опис додаткових розділів функціональних можливостей програми та способів їх вибору.
Урозділі «Повідомлення системному програмісту» повинно бути зазначено тексти повідомлень, які видаються в процесі виконання налаштування та перевірки програми, а також у процесі виконання програми, опису їхнього змісту і дій, що необхідно виконати за появи цих повідомлень.
Удодатку до керівництва системного програміста можуть бути наведені додаткові матеріали (приклади, ілюстрації, таблиці, графіки тощо).
2.2.7 Керівництво оператора
Керівництво оператора оформлюється згідно з ГОСТом 19.505– 78, відповідно до якого воно має містити наступні розділи:
–призначення програми;
–умови виконання програми;
–виконання програми;
–повідомлення оператору.
У залежності від особливостей документа допускається об’єднувати окремі розділи або вводити нові.
Урозділі «Призначення програми» повинно бути зазначено відомості про призначення програми та інформація, достатня для розуміння функцій програми та її експлуатації.
Урозділі «Умови виконання програми» повинно бути вказано умови, необхідні для виконання програми (мінімальний та/або максимальний склад апаратних і програмних засобів тощо).
Урозділі «Виконання програми» повинно бути зазначено послідовність дій оператора, що забезпечує завантаження, запускання, виконання й завершення програми, приведено опис функцій, формату і можливих варіантів команд, за допомогою яких оператор здійснює завантаження і керує виконанням програми, а також відповіді програми на ці команди.
23
Урозділі «Повідомлення оператору» повинно бути наведено тексти повідомлень, що з’являються в процесі виконання програми, опис їхнього змісту та відповідні дії оператора (дії оператора у випадку збою, можливості повторного запуску програми тощо).
Допускається зміст розділів ілюструвати прикладами, таблицями, схемами, графіками.
Удодатки до керівництва оператора допускається включати різні матеріали, що недоцільно включати в розділи керівництва.
2.3 Завдання до роботи
2.3.1Ознайомитися з основними теоретичними відомостями за темою роботи, використовуючи дані методичні вказівки, а також рекомендовану літературу.
2.3.2Відповідно до діючих стандартів оформити документ (технічне завдання, опис програми, керівництво програміста, керівництво системного програміста, керівництво оператора) на існуюче програмне забезпечення або на програму, розроблення якої передбачається (у випадку оформлення документу «Технічне завдання»), відповідно до номеру варіанту з таблиці Б.1.
2.3.3Оформити звіт з роботи.
2.3.4Відповісти на контрольні запитання.
2.4 Зміст звіту
2.4.1Тема та мета роботи.
2.4.2Завдання до роботи.
2.4.3Короткі теоретичні відомості.
2.4.4Оформлений програмний документ.
2.4.5Висновки, що містять відповіді на контрольні запитання (5 шт. за вибором студента), а також відображують результати виконання роботи та їх критичний аналіз.
2.5 Контрольні запитання
2.5.1 Обґрунтуйте необхідність оформлення програмної документації.
24
2.5.2Які основні документи оформлюються при розробленні програмного забезпечення?
2.5.3Які документи на Ваш погляд не є обов’язковими?
2.5.4З написання якого документу починається процес розроблення програмного забезпечення?
2.5.5Відповідно до якого стандарту оформляється документ «Технічне завдання»?
2.5.6Які розділи містить технічне завдання?
2.5.7Згідно з яким стандартом оформляється документ «Специ-
фікація»?
2.5.8З яких розділів складається специфікація?
2.5.9Який стандарт регламентує оформлення документу «Опис програми»?
2.5.10Які розділи містить опис програми?
2.5.11Відповідно до якого стандарту оформляється документ «Текст програми»?
2.5.12Проаналізуйте структуру документу «Керівництво про-
граміста».
2.5.13Згідно з яким стандартом оформляється документ «Керівництво системного програміста»?
2.5.14З яких розділів складається керівництво системного про-
граміста?
2.5.15Який стандарт регламентує оформлення документу «Керівництво оператора»?
2.5.16Які розділи містить керівництво оператора?
2.5.17Якими розділами відрізняються документи «Керівництво програміста» та «Керівництво системного програміста»?
2.5.18Порівняйте документи «Керівництво оператора» та «Керівництво програміста»?
2.5.19З якою метою оформлюється рецензія на документацію?
2.5.20Що є обов’язковим при написанні рецензії?
25
ЛІТЕРАТУРА
1.Мольц, М. Психокибернетика [Текст] / М. Мольц. –
СПб. : Питер, 2002. – 220 с.
2.Нуриев, Н. К. Дидактическое пространство подготовки компетентных специалистов в области программной инженерии [Текст] / Н. К. Нуриев. – Казань : Изд-во Казан. ун-та, 2005. – 244 с.
3. Стернберг, Р. Д. Практический интеллект [Текст] / Р. Д. Стернберг. – СПб. : Питер, 2002. – 272 с.
4.Герасимов, Б. М. Человеко-машинные системы принятия
решений с элементами искусственного интеллекта [Текст] / Б. М. Герасимов, В. А. Тарасов, И. В. Токарев. – К. : Наукова думка, 1993. – 180 с.
5. Друкер, П. Ф. Практика менеджмента [Текст] / П. Ф. Друкер. – М. : Издательский дом «Вильямс», 2001. – 398 с.
6.Мескон, М. Основы менеджмента [Текст] / М. Мескон, М. Альберт, Ф. Хедоури. – М. : Дело, 2004. – 800 с.
7.Фишер, Р. Путь к согласию, или переговоры без поражения [Текст] / Р. Фишер, У. Юри. – М. : Наука, 1992. – 158 с.
8.Гришина, Н. В. Психология конфликта [Текст] / Н. В. Гри-
шина. – СПб. : Питер, 2000. – 464 с.
9.ГОСТ 19.101-77. Виды программ и программных докумен-
тов [Текст]. – Введ. 1980-01-01. – М. : Изд-во стандартов, 1987. – 15 с.
10.ISO/IEC 12207:2008. Systems and software engineering – Software Life Cycle Processes [Текст]. – Second edition 2008-02-01. – Switzerland : International Organization for Standardization. – 138 p.
11.Кокин, А. Word 2003/2007. Народные советы [Текст] / А. Кокин. – СПб. : БХВ-Петербург, 2008. – 368 с.
12.Кеттел, Дж. Microsoft Office 2003. Полное руководство [Текст] / Д. Кеттел, Г. Харт-Девис, К. Симмонс [Пер. с англ.]. – М. :
Эком, 2006. – 832 с.
13.Веверка, П. Microsoft Office 2007 для чайников [Текст] / П. Веверка. – М. : Вильямс, 2009. – 768 с.
14.Глушаков, С. В. Microsoft Office 2007 [Текст] / С. В. Глуша-
ков, А. С. Сурядный. – М. : АСТ, 2008. – 624 с.
26
15.Лоу, Д. Microsoft Office PowerPoint 2007 для "чайников" [Текст] / Д. Лоу. – М. : Вильямс, 2007. – 304 с.
16.Уэмпен, Ф. PowerPoint 2003. Библия пользователя [Текст] / Ф. Уэмпен. – М. : Диалектика, 2005. – 768 с.
17.Безека, С. В. Создание презентаций в PowerPoint 2007 [Текст] / С. В. Безека. – М. : ВКТ, 2008. – 192 с.
18.Пащенко, И. Интернет [Текст] / И. Пащенко. – М. : Эксмо, 2009. – 480 с.
19.Толковый словарь сетевых терминов и аббревиатур [Текст].
–М. : Вильямс, 2002. – 368 с.
20.Гралла, П. Как работает Интернет [Текст] / П. Гралла. – М. :
АСТ, 2006. – 356 с.
21.Касперски, К. Тонкости и секреты работы с Интернет [Текст] / К. Касперски. – М. : Солон-Пресс, 2006. – 286 с.
22.Ашманов, И. Оптимизация и продвижение сайтов в поисковых системах [Текст] / И. Ашманов, А. Иванов. – 3- е изд. – СПб. : Пи-
тер, 2011. – 464 с.
27
Додаток А Приклад оформлення титульного листа звіту
з розрахунково-графічного завдання
Міністерство освіти і науки України Запорізький національний технічний університет
кафедра програмних засобів
ЗВІТ
зрозрахунково-графічного завдання № 2
здисципліни "Групова динаміка і комунікації" на тему:
"ОФОРМЛЕННЯ ПРОГРАМНОЇ ДОКУМЕНТАЦІЇ"
Виконав: |
|
студент групи ІОТ-410 |
А. Б. Іваненко |
Прийняв: |
|
к.т.н., доцент |
В. М. Льовкін |
2014
28
Додаток Б Завдання для оформлення програмної документації
Таблиця Б.1 – Варіанти виконання завдання
№ ва- |
Програмний документ |
Програмне забезпечення |
|
ріанту |
|
|
|
1 |
технічне завдання |
програма запису голосових за- |
|
міток |
|||
|
|
||
2 |
опис програми |
Mozilla Firefox |
|
3 |
керівництво системно- |
Media Player Classic |
|
го програміста |
|||
|
|
||
4 |
керівництво програміс- |
2048 |
|
|
та |
|
|
5 |
керівництво оператора |
VLC Media Player |
|
6 |
опис програми |
Miranda |
|
7 |
технічне завдання |
веб-браузер |
|
8 |
керівництво системно- |
Mantis Bug Tracker |
|
го програміста |
|||
|
|
||
9 |
керівництво оператора |
BitComet |
|
10 |
керівництво оператора |
Celtx |
|
11 |
керівництво програміс- |
Mailpile |
|
|
та |
|
|
12 |
опис програми |
GIMP |
|
13 |
керівництво оператора |
Bugzilla |
|
14 |
технічне завдання |
онлайн-сервіс створення презе- |
|
нтацій |
|||
|
|
||
15 |
керівництво системно- |
Roundcube Webmail |
|
го програміста |
|||
|
|
||
16 |
керівництво програміс- |
FreeImage |
|
|
та |
|
|
17 |
керівництво оператора |
foobar2000 |
|
18 |
керівництво системно- |
Breach |
|
го програміста |
|||
|
|
||
19 |
технічне завдання |
додаток для відновлення втра- |
|
чених даних |
|||
|
|
||
20 |
технічне завдання |
сервіс онлайн-продажу квитків |
29
|
|
на літаки |
|
21 |
керівництво програміс- |
Mozilla Thunderbird |
|
|
та |
|
|
22 |
керівництво оператора |
LyX |
|
23 |
керівництво програміс- |
Stellarium |
|
|
та |
|
|
24 |
опис програми |
PeerGuardian |
|
25 |
технічне завдання |
клієнт сервісу SoundCloud |
|
26 |
керівництво оператора |
Evernote |
|
27 |
опис програми |
Iometer |
|
28 |
керівництво програміс- |
ClamWin |
|
|
та |
|
|
29 |
технічне завдання |
відеоредактор |
|
30 |
технічне завдання |
RSS-агрегатор |
|
31 |
опис програми |
Scribus |
|
32 |
керівництво системно- |
ClamWin |
|
го програміста |
|||
|
|
||
33 |
керівництво програміс- |
Avogadro |
|
|
та |
|
|
34 |
керівництво оператора |
Miranda |
|
35 |
технічне завдання |
антивірусний сканер |
|
36 |
керівництво системно- |
Pidgin |
|
го програміста |
|||
|
|
||
37 |
керівництво оператора |
BitSpirit |
|
38 |
керівництво програміс- |
VLC Media Player |
|
|
та |
|
|
39 |
опис програми |
Roundcube Webmail |
|
40 |
керівництво системно- |
Mozilla Firefox |
|
го програміста |
|||
|
|
||
41 |
керівництво програміс- |
Chaotic Rage |
|
|
та |
|
|
42 |
технічне завдання |
сервіс відеомовлення |
|
43 |
керівництво оператора |
BitTorrent |
|
44 |
опис програми |
gramps |
|
45 |
технічне завдання |
онлайн-радіо |
|
46 |
керівництво системно- |
phpList |
30
|
го програміста |
|
|
47 |
керівництво оператора |
RetroShare |
|
48 |
опис програми |
0 A.D. |
|
49 |
керівництво програміс- |
Bluefish |
|
|
та |
|
|
50 |
технічне завдання |
онлайн-сервіс збереження нота- |
|
ток |
|||
|
|
||
51 |
керівництво оператора |
Pidgin |
|
52 |
керівництво програміс- |
atomiks |
|
|
та |
|
|
53 |
опис програми |
2048 |
|
54 |
керівництво оператора |
Mozilla Thunderbird |
|
55 |
керівництво програміс- |
Opencsv |
|
|
та |
|
|
56 |
керівництво оператора |
Mantis Bug Tracker |
|
57 |
технічне завдання |
менеджер завдань |
|
58 |
опис програми |
Oolite |
|
59 |
керівництво оператора |
Avidemux |
|
60 |
технічне завдання |
менеджер завантажень |
|
61 |
керівництво оператора |
Pencil Project |
|
62 |
опис програми |
Avogadro |
|
63 |
керівництво програміс- |
Miranda |
|
|
та |
|
|
64 |
керівництво програміс- |
CellProfiler |
|
|
та |
|
|
65 |
керівництво оператора |
µTorrent |
|
66 |
технічне завдання |
програма запису дзвінків у |
|
Skype |
|||
|
|
||
67 |
керівництво програміс- |
0 A.D. |
|
|
та |
|
|
68 |
опис програми |
Stellarium |
|
69 |
керівництво системно- |
PeerGuardian |
|
го програміста |
|||
|
|
||
70 |
технічне завдання |
додаток для пошуку товарів за |
|
зображенням |
|||
|
|
||
71 |
керівництво оператора |
ClamWin |