Розробка документації користувача
Під документацією користувача розуміється документація, яка забезпечує кінцевого користувача інформацією з встановлення та експлуатації програмного пакета. Під інформацією на упаковці розуміють інформацію, відтворену на зовнішній упаковці програмного пакета. Її метою є надання потенційним покупцям первинних відомостей про програмний пакет.
Користувацька документація програмного засобу пояснює користувачам, як вони повинні діяти, щоб застосувати дану програму. Вона необхідна, якщо програма передбачає будь-яку взаємодію з користувачами. До такої документації належать документи, якими керується користувач при установці програми з відповідної налаштуванням на середу застосування, при застосуванні програми для вирішення своїх завдань і при управлінні програмою (наприклад, коли даний програмний засіб взаємодіє з іншими системами). Ці документи частково торкаються питань супроводження програмного засобу, але не стосуються питань, пов'язаних з модифікацією програм.
Після
ознайомлення з довідковою інформацією
і методичними матеріалами починаю
розробляти посібник користувача для
даної системи. Для початку визначаюсь
з структурою посібника, тобто складаю
список розділів, які мають міститись у
посібнику. Розглянувши методичні
матеріали, я обрав наступну структуру:
Основні відомості
Огляд
Призначення
Режими
Робота з програмою
Інсталяція
Запуск
Додання записів
Переглядання записів
Редагування записів
Перегляд статистики
Автор
В розділі «Основні Відомості» опис базові відомості про програму: сферу застосування і функціональні можливості.
У розділі «робота з програмою» міститься детальний опис всіх операцій які доступні у програмі. Також для прикладу приводяться ілюстрації
Висновки
Переддипломна практика студентів є завершальним етапом навчання, до неї допускаються студенти, що завершили курс теоретичного навчання за вказаною спеціальністю незалежно від форми навчання.
Проводиться на випускному курсі з метою узагальнення і вдосконалення здобутих ними знань, практичних умінь та навичок, оволодіння професійним досвідом та готовності їх до самостійної трудової діяльності, а також збору матеріалів для дипломного проектування.
Переддипломна практика покликана сформувати у студента уміння і навички прийняття самостійних рішень на конкретній дільниці в реальних умовах виробництва чи науково-дослідного підрозділу.
Під час виконання даної переддипломноїпрактики я ознайомився з роботою студії веб дизайну WebDreamLab директором якої є Фізична особа підприємець Строгуш Володимир Володимирович, я отримав дуже багато практичних навичок і змогу попрацювати в умовах які наближені до сьогоденних реалій.
На підприємстві я краще оволодів навиками розробки програмного забезпечення і оформлення документації для створюваного ПЗ, проектувати моделі конкретних бізнес – процесів, і краще ознайомився з принципами командної розробки проектів.
Додатки
Додаток А. Лістинг програми
Home.cpp
//---------------------------------------------------------------------------
#include <vcl.h>
#pragma hdrstop
#include "home.h"
#include "statyst.h"
#include "add.h"
#include "start.h"
#include "view_edit.h"
#include "ABOUT.h"
//---------------------------------------------------------------------------
#pragma package(smart_init)
#pragma resource "*.dfm"
TForm1 *Form1;
//---------------------------------------------------------------------------
__fastcall TForm1::TForm1(TComponent* Owner)
: TForm(Owner)
{
LoadPercent = 0;
int mas[100];
srand(time(NULL));
TForm2 *Form2 = new TForm2(NULL);
Form2->Position = poScreenCenter;
Form2->Show();
for (LoadPercent = 0; LoadPercent < 100; LoadPercent+=2) {
Sleep(10 + rand() % 200);
for (int j = 0; j < 10000; j++) { mas[LoadPercent] = rand()%9;
Application->ProcessMessages();
}
}
Form2->Timer1->Enabled = false;
delete Form2; Form2 = NULL;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::Button1Click(TObject *Sender)
{
this->N2->Click();
this->Button3->Visible=true;
this->Button1->Visible=false;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N3Click(TObject *Sender)
{
//zamovl
int x,y,d,i=0;
AnsiString stat;
this->ADOTable->TableName="zamovl";
this->ADOTable->Active=true;
this->List->Clear();
this->Label2->Caption="Список замовлень";
while(!this->ADOTable->Eof){
AnsiString z = this->ADOTable->FieldByName("#")->AsString+": "+this->ADOTable->FieldByName("Найменування замовлення")->AsString+" - "+this->ADOTable->FieldByName("Опис")->AsString+" // "+this->ADOTable->FieldByName("Тип")->AsString+" // "+this->ADOTable->FieldByName("Дата здачі")->AsString;
//визначити критичні проекти....
x = StrToDate(this->ADOTable->FieldByName("Дата здачі")->AsString);
y = StrToDate(this->Calend1->Date.CurrentDate());
stat = this->ADOTable->FieldByName("статус")->AsString;
d = x-y;
if((d<14)&&(stat=="False")){
this->List2->Items->Add(z);
i++;
} //if
if (this->List2->Items->Count>0) {
this->alert->Visible=true;
this->Height=475;
this->Width=505;
this->Label3->Caption=i;
}
this->ADOTable->Next();
this->List->Items->Add(z);
d=x=y=0;
}//while
this->Edit1->Text=stat;
this->ADOTable->Active=false;
this->Bar1->Panels->Items[1]->Text="Замовлень";
this->Bar1->Panels->Items[3]->Text=this->List->Items->Count;
this->Bar1->Panels->Items[4]->Text=this->Calend1->Date.CurrentDate();
this->is_client->Checked=false;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N2Click(TObject *Sender)
{
//clients
this->ADOTable->TableName="Clients";
this->ADOTable->Active=true;
this->List->Clear();
this->Label2->Caption="Список клієнтів";
while(!this->ADOTable->Eof){
AnsiString c = this->ADOTable->FieldByName("#")->AsString+": "+this->ADOTable->FieldByName("ПІБ")->AsString+" - "+this->ADOTable->FieldByName("телефон")->AsString+" // "+this->ADOTable->FieldByName("е-пошта")->AsString;
this->ADOTable->Next();
this->List->Items->Add(c);
}
this->ADOTable->Active=false;
this->Bar1->Panels->Items[1]->Text="Клієнтів";
this->Bar1->Panels->Items[3]->Text=this->List->Items->Count;
this->Bar1->Panels->Items[4]->Text=this->Calend1->Date.CurrentDate();
this->is_client->Checked=true;
this->Height=314;
this->Width=505;
this->List2->Clear();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::Button5Click(TObject *Sender)
{
char *buf = (char*) malloc(100);
GetCurrentDirectory(100, buf);
Label5->Caption = buf;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::Button4Click(TObject *Sender)
{
edit_form->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N5Click(TObject *Sender)
{
edit_form->Show();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::ListClick(TObject *Sender)
{
this->poz->Text=this->List->ItemIndex;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::Button3Click(TObject *Sender)
{
this->N3->Click();
this->Button3->Visible=false;
this->Button1->Visible=true;
}
//---------------------------------------------------------------------------
void __fastcall TForm1::Button2Click(TObject *Sender)
{
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N12Click(TObject *Sender)
{
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N7Click(TObject *Sender)
{
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::FormCreate(TObject *Sender)
{
this->N3->Click();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N6Click(TObject *Sender)
{
this->go_edit->Checked=true;
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N10Click(TObject *Sender)
{
AboutBox->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N11Click(TObject *Sender)
{
this->Button4->Click();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N13Click(TObject *Sender)
{
this->go_edit->Checked=true;
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N15Click(TObject *Sender)
{
AboutBox->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N16Click(TObject *Sender)
{
static_form->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N17Click(TObject *Sender)
{
this->go_edit->Checked=true;
View->ShowModal();
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N9Click(TObject *Sender)
{
AnsiString FILE_HELP_NAME_STR = "pysar.chm";
if (FileExists(FILE_HELP_NAME_STR) )
{
ShellExecute(Handle, "open", "pysar.chm", 0, 0, SW_SHOWNORMAL);
return;
}
else
{
ShowMessage("Файл довідки \"pysar.chm\" у робочому каталозі програми не знайдено. Перевстановіть програму для усунення даної проблеми.");
return;
}
}
//---------------------------------------------------------------------------
void __fastcall TForm1::N14Click(TObject *Sender)
{
AnsiString FILE_HELP_NAME_STR = "pysar.chm";
if (FileExists(FILE_HELP_NAME_STR) )
{
ShellExecute(Handle, "open", "pysar.chm", 0, 0, SW_SHOWNORMAL);
return;
}
else
{
ShowMessage("Файл довідки \"pysar.chm\" у робочому каталозі програми не знайдено. Перевстановіть програму для усунення даної проблеми.");
return;
}
}
//---------------------------------------------------------------------------
Add.cpp
#include <vcl.h>
#pragma hdrstop
#include "add.h"
#include "home.h"
//---------------------------------------------------------------------------
#pragma package(smart_init)
#pragma resource "*.dfm"
Tedit_form *edit_form;
//---------------------------------------------------------------------------
__fastcall Tedit_form::Tedit_form(TComponent* Owner)
: TForm(Owner)
{
}
//---------------------------------------------------------------------------
void __fastcall Tedit_form::Button1Click(TObject *Sender)
{
this->DBNavigator1->BtnClick(nbEdit);
this->DBNavigator1->BtnClick(nbPost);
this->Close();
}
//---------------------------------------------------------------------------
void __fastcall Tedit_form::FormActivate(TObject *Sender)
{
this->DBNavigator2->BtnClick(nbLast);
this->DBNavigator2->BtnClick(nbInsert);
this->DBNavigator1->BtnClick(nbLast);
this->DBNavigator1->BtnClick(nbInsert);
this->DBEdit1->Clear();
this->DBEdit2->Clear();
this->DBEdit3->Clear();
this->DBEdit4->Clear();
this->DBEdit5->Clear();
this->DBEdit6->Clear();
this->DBEdit7->Clear();
this->DBEdit8->Clear();
this->DBEdit9->Clear();
this->DBEdit10->Clear();
this->DBMemo1->Clear();
if(Form1->is_client->Checked==true){
this->Height=360;
this->Width=430;
this->Label1->Caption="Додати клієнта";
this->klient->Visible=true;
this->zamovlen->Visible=false;
}else{
this->Height=540;
this->Width=460;
this->Label1->Caption="Додати замовлення";
this->zamovlen->Visible=true;
this->klient->Visible=false;
}
this->ADOTable1->TableName="Clients";
this->ADOTable1->Active=true;
this->ComboBox1->Clear();
while(!this->ADOTable1->Eof){
AnsiString c = this->ADOTable1->FieldByName("ПІБ")->AsString;
this->ComboBox1->Items->Add(c);
this->ADOTable1->Next();
}
this->ADOTable1->Active=false;
}
//---------------------------------------------------------------------------
void __fastcall Tedit_form::Button4Click(TObject *Sender)
{
this->DBEdit8->Text=this->MaskEdit1->Text;
this->DBEdit9->Text=this->MaskEdit2->Text;
this->DBEdit10->Text=this->ComboBox1->Items->Text;
this->DBNavigator2->BtnClick(nbEdit);
this->DBNavigator2->BtnClick(nbPost);
this->Close();
}
//---------------------------------------------------------------------------
void __fastcall Tedit_form::Button2Click(TObject *Sender)
{
this->Close();
}
//---------------------------------------------------------------------------
void __fastcall Tedit_form::Button5Click(TObject *Sender)
{
this->Close();
}
//---------------------------------------------------------------------------