 |
|
Додаток З. Рекомендації до створення інструкції користувача
1. Компоненти ПЗ. В цьому підрозділі потрібно коротко описати розроблене ПЗ – використані технології, середовища розробки, мови програмування тощо.
Приклад.
Пакет розроблено на мові програмування C# 3.0 у середовищі розробки Microsoft Visual Studio .NET 2008 і може експлуатуватися під управлінням сімейства операційних систем Windows. Під час проектування підсистем відбувалося поєднання об’єктно-орієнтованого підходу до програмування з процедурно-орієнтованим. Всі класи документувались інформаційно і семантично.
Крім цього подати вимоги до програмно-апаратних засобів, базовий набір файлів ПЗ та використані компоненти сторонніх розробників (фреймворки, бібліотеки, контроли тощо).
Приклад.
Для коректної роботим пакету необхідна користувацька машина з процесором не менше 200 MHz, оперативною пам’яттю не менше 256 Mb. Для експлуатації пакету під управлінням сімейства операційних систем Windows необхідно встановити збірку класів .NET Framework 3.5, мати в наявності всі необхідні файли бібліотек і налаштувань. Перелік необхідних файлів, пояснення їх призначення та інформація про приналежність до конкретного проекту наведено у табл. 1.
Таблиця 1.
Набір файлів для коректної роботи ППП «Кластеризація»
| № | Файл | Призначення | Належить проекту |
| AForge.dll | Бібліотека ядра | AForge.NET | |
| AForge.Imaging.dll | Бібліотека для обробки зображень | ||
| app.config | Файл налаштувань підсистеми кластеризації образів | ППП «Кластеризація» | |
| ClustersCore.dll | Бібліотека ядра | ||
| ImageClustering.exe | Виконавчий файл підсистеми кластеризації образів | ||
| log.txt | Текстовий файл, що містить записи журналу |
Підсистема кластеризації образів використовує засоби проекту з відкритим кодом (open source) Image Processing Lab (IPLab) [джерело], який є віконним проектом для взаємодії з бібліотекою AForge.NET і призначений для обробки зображення. В свою чергу, проект IPLab використовує такі компоненти з відкритим кодом: DockManager Control (розробник Weifen Luo) [джерело]; SourceGrid (розробник Davide Icardi) [джерело]; A Simple C# Toolbar Docking Framework (розробник Rogério Paulo) [джерело].
2. Встановлення ПЗ – перелік необхідного спеціалізованого ПЗ сторонніх виробників та порядок дій для встановлення ПЗ.
Приклад.
Для роботи пакету необхідно встановити SQL Server 2005/2008.
Якщо необхідно здійснити базові налаштування, то файл з переліком налаштувань додається до диску з ПЗ. Якщо налаштування можна коротко охарактеризувати – тоді подати в цій інструкції.
Приклад.
Для роботи пакету необхідно встановити SQL Server 2005/2008. При цьому потрібно встановити повнотекстовий пошук.
Приклад.
1. Встановити SQL Server 2005/2008.
2. Встановити пакет ImageProcessingDB запустивши на виконання файл ipDB_setup.exe.
3. Запустити на виконання файл ipdb.exe, який створить базу даних IMGPROCDB та всі необхідні таблиці.
3. Налаштування ПЗ – опис налаштувань, які підтримуються в системі для коректної роботи програми (у випадку відсутності його в розділі реалізації).
4. Базові функції ПЗ – опис базових функцій ПЗ. Потрібно коротко описати функцію розробленого ПЗ та щонайменше один спосіб доступу до неї.
Приклад.
Для збереження результатів перетворення зображення в головному меню виберіть пункт – «Зберегти результати».
Приклад.
Для запуску обчислення результатів виберіть почергово такі пунки головного меню:
1. «Згенерувати».
2. «Поділити простір».
3. «Обчислити відстань».
4. Аналіз помилок – опис можливих помилок та проблем і шляхи їх розв’язання. Зазвичай розроблене ПЗ містить файл журналу, куди записують всі події викликані користувачем.
Приклад.
У випадку збою програми переглянути файл log.txt.
При виникненні повідомлення «Memory 2 error» - закрити програму, почистити кеш в папці Cache, запустити програму.