Чтобы описать программу , начните с общего вступления. Опишите основную проблему, с которой сталкивается пользователь. Естественно, это должна быть та самая проблема, которую и решает описываемая программа. Кстати это хороший способ сразу же очертить целевую аудиторию пользователей. Те, кому она будет полезна и необходима, ее скачают или купят. Другие же пользователи сэкономят время и не станут далее читать. Также во вступлении кратко опишите основные возможности программы. Для этого достаточно 1-2 предложений.
Укажите системные требования к компьютерному оборудованию. Чтобы наиболее полно описать программу , сделайте градацию. Распишите минимальные требования и требования для комфортной работы.
Опишите интерфейс и рабочее пространство. Чтобы описать программу более наглядно, используйте скриншоты разных ее рабочих окон и состояний. Опишите основные панели инструментов, расположение пунктов меню, строки состояний и т.п.
Невозможно описать программу , не рассказав подробно о ее основных функциях. Это можно сделать в виде списка или перечня. Однако важно в данном пункте соблюдать конкретику. К примеру, фраза «эффективная работа с проектами» не несет в себе никакой смысловой нагрузки. Точнее, смысловая нагрузка, конечно, есть, но она относительна и не сообщает читателю никаких фактов.
Указав основные функции программы, распишите ее дополнительные функции, которые могут быть особенно удобны и полезны пользователю. К примеру, это могут быть возможности быстрой интеграции с другим программным обеспечением, улучшения в скорости работы, удобные для использования элементы дизайна и т.д.
Чтобы описать программу новой версии, расскажите о тех изменениях, которые она претерпела с момента ее предыдущего обновления. Опишите, какой функционал был убран, какие проблемы решены, что появилось нового, что было изменено, доработано и улучшено. Отличия от прошлых версий также можно представить в виде списка.
Сделайте заключение, в котором еще раз подчеркните целевую аудиторию и основное назначение программы, упомянув ее выигрышные стороны.
3. ОПИСАНИЕ СТРУКТУРЫ ПРОГРАММЫ
Описание переменных
В разделе описаний переменных описаны переменные, назначение которых приведено в таблице 3.1.
Таблица 3.1– Описание переменных программы
Наименование | Тип | Назначение |
FO,FS | TextFile | Переменная текстового файла исходного и результирующего |
tmpstr,str,strslovo | String | Строковые переменные для чтения из файла |
i,j | integer | Переменные счетчики для циклов |
count | integer | Переменная хранит количество исправленных символов |
answ | Word | Используется для определения ответа пользователя на вопрос об исправлении символа |
UpCh | set of char | Множество заглавных символов |
ZnCh | set of char | Множество символов разделителей слов |
OFName | String | Строка, в которой хранится путь к исходному файлу |
SFName | String | Строка, в которой хранится путь к результирующему файлу |
В программе приведено описание одной вспомогательной процедуры.
Процедура FormCreate вывода исходных значений в компоненты формы для корректного отображения формы в начале работы программы.
Процедура Button1Click для отрытия исходного файла и сохранения пути к нему.
Процедура Button2Click для отрытия результирующего файла и сохранения пути к нему.
Алгоритм основной программы
Алгоритм выполнения основного тела программы приведен на рисунке А.1 в приложении А. Так в процедуре в первую очередь осуществляется привязка файла к файловой переменной и открытие текстового файла для чтения текстовой информации.
Затем производится чтение информации из файла построчно.
Затем в каждой строке выделяются слова.
Затем осуществляется поиск в выделенных словах заглавных символов.
Затем происходит запись в результирующий текстовый файл изменений.
В ходе выполнения работы использовались следующие операции работы с текстовыми файлами:
AssignFile (<Имя файловой переменной>,<Имя файла>);
Имя файла задается либо строковой константой, либо через переменную типа Sting. Имя файла должно соответствовать правилам работающей в данный момент операционной системы. Если строка имени пустая, то связь файловой переменной осуществляется со стандартным устройством ввода-вывода.
Reset (<Имя файловой переменной>);
Открывается файл для чтения из него информации, ему присваивается имя, заданное процедурой Assign.
После работы с файлом он, как правило, должен быть закрыт процедурой CloseFile (<Имя файловой переменной>). Вывод информации производит оператор WRITELN(f: TextFile;S: String). После его выполнения строка S заносится в конец файла, связанного с переменной f.
4. ОПИСАНИЕ ВХОДНЫХ ДАННЫХ
Исходными данными для выполнения является файл, который содержит заглавные символы.
5. ОПИСАНИЕ ВЫХОДНЫХ ДАННЫХ
Выходными данными являются:
Сообщение о завершении проверки файла на наличие в нем заглавных символов;
Сообщение о количестве исправленных символов;
Заполненный результирующий текстовый файл.
6. ИНСТРУКЦИЯ ОПЕРАТОРУ
Разработанная программа представляет собой исполняемый файл Luchshev.exe размером 405 Кбайт. В программе реализован алгоритм проверки текстового файла на наличие в нем заглавных символов.
После запуска программы появляется окно, изображенное на рисунке 4.1.
Рисунок 4.1 – Главное окно программы
После этого пользователь должен задать путь к файлу. На рисунке 4.2 показан пример диалогового окна для открытия файла.
Рисунок 4.2 – Пример отскрытия исходного файла
Пример сообщения о нахождении заглавного символа приведен на рисунке 4.3.
Рисунок 4.3– Сообщение о нахождении заглавного символа
Пример окна с результатом проверки текстового файла приведен на рисунке 4.4.
Рисунок 4.4- Результирующее окно.
Результат проверки записывается в выбранный результирующий файл находящийся в выбранной директории.
Функционирование программы полностью соответствует заданию.
Данная курсовая работа была выполнена в полном соответствии поставленному заданию и отлажена в среде Delphi 7.0. В ходе выполнения курсовой работы была разработана программа для проверки текстового файла.
В ходе выполнения курсового проекта были проведен - анализ технического задания и постановка задачи проектирования.
Были выделены функции, которыми должна обладать разрабатываемая программа.
Был разработан алгоритм программы, предназначенной для выполнения сформированных функций.
Согласно разработанному алгоритму была составлена и отлажена программа алгоритмическом языке программирования Delphi. В ходе разработки программы проводилось ее тестирование и отладка на тестовых наборах. Для написанной программы разработана инструкция оператора с указанием порядка выполняемых действий.
Результаты работы оформлены в виде пояснительной записки.
В ходе разработки программы были закреплены навыки работы:
Командами ввода-вывода как на экран, так и в текстовые файлы,
Использования процедур,
Команды обработки массивов,
Команды для реализации циклов с заданным числом повторений;
Команды проверки условий и реализации ветвлений.
В результате выполнения данной курсовой работы, мы убедились в широких возможностях языка программирования Delphi, закрепили практические навыки программирования в cреде Delphi.
Перечень ссылок
1. Зуев Е.А. Программирование на языке Delphi 6.0,7.0. – М.: Радио и связь, Веста, 1993.
2. Фаронов В.В. Delphi 7.0. Начальный курс. - М.: Нолидж, 2000.
|
Алгоритм программы
Рисунок А.1 – Алгоритм программы
Рисунок А.2 – Алгоритм основной процедуры программы
ПРИЛОЖЕНИЕ Б
Листинг программы
4. Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
5. Dialogs, StdCtrls;
7. TForm1 = class(TForm)
8. Button1: TButton;
9. Button2: TButton;
10. OpenDialog1: TOpenDialog;
11. SaveDialog1: TSaveDialog;
12. Button3: TButton;
13. Label1: TLabel;
14. Label2: TLabel;
15. Label3: TLabel;
16. Label4: TLabel;
17. Button4: TButton;
18. procedure Button1Click(Sender: TObject);
19. procedure Button2Click(Sender: TObject);
20. procedure FormCreate(Sender: TObject);
21. procedure Button3Click(Sender: TObject);
22. procedure Button4Click(Sender: TObject);
24. { Private declarations }
26. { Public declarations }
29. Form1: TForm1;
30. OFName,SFName:String;
31. implementation
33. procedure TForm1.Button1Click(Sender: TObject);
35. if OpenDialog1.Execute then
36. OFName:=OpenDialog1.FileName;
37. if OFName<>"" then begin
38. Button1.Enabled:=False;
39. Button2.Visible:=True;
40. Label1.Caption:="Путь к файлу для проверки: "+OFName;
41. Label2.Visible:=True;
45. procedure TForm1.Button2Click(Sender: TObject);
50. if SaveDialog1.Execute then
51. SFName:=SaveDialog1.FileName;
52. if Pos(".txt",SFName)=0 then SFName:=SFName+".txt";
53. if SFName=OFName then
54. ShowMessage("Выберите другой файл для сохранения результата")
57. if (SFName<>"") and (b) then begin
58. Button2.Enabled:=False;
59. Label2.Caption:="Путь к результирующему файлу: "+SFName;
60. Button3.Visible:=True;
61. Label3.Visible:=True;
62. Label3.Caption:="Для начала проверки нажмите на кнопку "Проверить"";
65. procedure TForm1.FormCreate(Sender: TObject);
67. Button2.Visible:=False;
68. Label2.Visible:=False;
69. Button3.Visible:=False;
70. Label3.Visible:=False;
71. Button4.Visible:=False;
72. Label4.Visible:=False;
73. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";
75. procedure TForm1.Button3Click(Sender: TObject);
77. FO,FS:TextFile;
78. i,j,count:integer;
79. str,strslovo,tmpstr:String;
80. ZnCh,UpCh:set of Char;
84. ZnCh:=[".",",","!","?"];
85. UpCh:=["A".."Z","А".."Я"];
86. AssignFile(FO,OFName);
87. AssignFile(FS,SFName);
91. if IOResult<>0 then begin
92. ShowMessage("Произошли проблемы с открытием файла. Программа будет завершена");
96. Rewrite(FS);
97. while not Eof(FO) do begin
98. Readln(FO,str);
99. strslovo:="";
100. for i:=1 to Length(str) do begin
101. if (str[i] in ZnCh) or (str[i]=" ") then begin
102. for j:=1 to Length(strslovo) do begin
a. if strslovo[j] in UpCh then begin
b. answ:=MessageDlg("В слове ""+strslovo+"" найдена заглавная буква ""+strslovo[j]+"". Заменить ее на малую?",mtInformation,,0);
c. if answ=mrYes then begin
i. tmpstr:=strslovo[j];
ii. tmpstr:=AnsiLowerCase(tmpstr);
iii. Delete(strslovo,j,1);
iv. Insert(tmpstr,strslovo,j);
104. Write(FS,strslovo+str[i]);
105. strslovo:="";
108. strslovo:=strslovo+str[i];
110. Writeln(FS,"");
112. CloseFile(FO);
113. CloseFile(FS);
114. Label3.Caption:="Проверка файла завершена. Исправлено "+IntToStr(count)+" заглавных букв.";
115. Button3.Enabled:=False;
116. Button4.Visible:=True;
117. Label4.Visible:=True;
120. procedure TForm1.Button4Click(Sender: TObject);
122. OFName:="";
123. SFName:="";
124. Button1.Enabled:=True;
125. Button2.Visible:=False;
126. Button2.Enabled:=True;
127. Button3.Visible:=False;
128. Button3.Enabled:=True;
129. Button4.Visible:=False;
130. Label2.Visible:=False;
131. Label3.Visible:=False;
132. Label4.Visible:=False;
133. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";
|
Результаты решения программы
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01. 1980 г.
1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определённого ГОСТ 19.101-77 .
Стандарт полностью соответствует СТ СЭВ 2092-80.
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .
Составление информационной части (аннотации и содержания) является обязательным.
3. Описание программы должно содержать следующие разделы:
- общие сведения;
- функциональное назначение;
- описание логической структуры;
- используемые технические средства;
- входные данные;
- выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе «Общие сведения» должны быть указаны:
- обозначение и наименование программы;
- программное обеспечение, необходимое для функционирование программы;
- языки программирования, на которых написана программа.
5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
6. В разделе «Описание логической структуры» должны быть указаны:
- алгоритм программы;
- используемые методы;
- структура программы с описанием функций составных частей и связи между ними;
- связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6.(Измененная редакция, Изм. № 1).
7. В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.
- способ вызова программы с соответствующего носителя данных;
- входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
9. В разделе «Входные данные» должны быть указаны:
- характер, организация и предварительная подготовка входных данных;
- формат, описание и способ кодирования входных данных.
10. В разделе «Выходные данные» должны быть указаны:
- характер и организация выходных данных;
- формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12.(Введены дополнительно, Изм. № 1).
* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)
Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе.
Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения.
ГОСТы и стандарты
Структуру и оформление документа определяется в .
Информационная часть (аннотации и содержания) в соответствии с .
В каких случаях необходим
Документ необходим для информирования потенциальных пользователей и покупателей о назначении программы и способах применения. Больше подходит для менеджеров (специалистов, системных администраторов), которые самостоятельно принимают решение о приобретении программы и вводе её в эксплуатацию.
Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение.
В описании программы и описании применения указываются:
Задачи, которые решает программа;
Затрачиваемые ресурсы для работы;
Вводная информация;
Выходные данные.
Акцент делается на описательной части программы, её функциях и назначении. В меньшей степени на описании применения. Делается описание именно о возможностях программы и задач, которая она решает, а не её внутреннего устройства. При определённых особенностях программы допускается объединять разделы или вводить новые (дополнительные).
Структура описания программы (ГОСТ 19.402-78):
1. Общие сведения.
2. Функциональное назначение программы.
3. Описание логической структуры.
4. Технические средства, которые используются.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.
Структура описания применения (ГОСТ 19.502-78):
1. Назначение программы.
2. Условия применения.
3. Описательная часть задачи.
4. Входные и выходные данные.
5. приложения (таблицы, иллюстрации и т.д.).
Вы можете заказать разработку документа или полного комплекта документации на программное обеспечение.