На каждый программный продукт должна разрабатываться документация двух типов: для пользователей различных групп и для разработчиков. Отсутствие документации любого типа не допустимо.
При подготовке документации не следует забывать, что она разрабатывается для того, чтобы ее можно было использовать, и потому она должна содержать все необходимые сведения.
К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. Документирование программного обеспечения осуществляется в соответствии с единой системой программной документации (ГОСТ 19.ХХХ). ГОСТ 19.101-77 устанавливает виды программных документов для программного обеспечения различных типов.
Спецификация должна содержать перечень и краткое описание назначения всех файлов программного обеспечения, в том числе и файлов документации на него, и является обязательной для программных систем, а также их компонентов, имеющих самостоятельное применение.
TestMem 5 — программа для теста оперативной памяти.
Ведомость держателей подлинников (код вида документа — 05) должна содержать список предприятий, на которых хранятся подлинники программных документов. Необходимость этого документа определяется на этапе разработки и утверждения технического задания только для программного обеспечения со сложной архитектурой.
Текст программы (код вида документа — 12) должен содержать текст программы с необходимыми комментариями. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Описание программы (код вида документа — 13) должно содержать сведения о логической структуре и функционировании программы. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Ведомость эксплуатационных документов (код вида документа — 20) должна содержать перечень эксплуатационных документов на программу, к которым относятся документы с кодами: 30, 31, 32, 33, 34, 35, 46. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Формуляр (код вида документа — 30) должен содержать основные характеристики программного обеспечения, комплектность и сведения об эксплуатации программы.
Описание применения (код вида документа — 31) должно содержать сведения о назначении программного обеспечения, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.
Руководство системного программиста (код вида документа — 32) должно содержать сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.
Руководство программиста (код вида документа — 33) должно содержать сведения для эксплуатации программного обеспечения.
Руководство оператора (код вида документа — 34) должно содержать сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программного обеспечения.
Автоматическая очистка оперативной памяти на ПК
Описание языка (код вида документа — 35) должно содержать описание синтаксиса и семантики языка.
Руководство по техническому обслуживанию (код вида документа — 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании технических средств.
Программа и методика испытаний (код вида документа — 51) должны содержать требования, подлежащие проверке при испытании программного обеспечения, а также порядок и методы их контроля.
Пояснительная записка (код вида документа — 81) должна содержать информацию о структуре и конкретных компонентах программного обеспечения, в том числе схемы алгоритмов, их общее описание, а также обоснование принятых технических и технико-экономических решений. Составляется на стадии эскизного и технического проекта.
Прочие документы (коды вида документа – 90-99) могут составляться на любых стадиях разработки, т.е. на стадиях эскизного, технического и рабочего проектов.
Допускается объединять отдельные виды эксплуатационных документов, кроме формуляра и ведомости. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. В настоящее время используется документ «Руководство пользователя», в который отчасти входит руководство системного программиста, программиста и оператора.
Пояснительная записка должна содержать всю информацию, необходимую для сопровождения и модификации программного обеспечения: сведения о его структуре и конкретных компонентах, общее описание алгоритмов и их схемы, а также обоснование принятых технических и технико-экономических решений.
Содержание пояснительной записки по стандарту (ГОСТ 19.404-79):
— Назначение и область применения;
— Ожидаемые технико-экономические показатели;
— Источники, используемые при разработке.
В разделе Введение указывают наименование программы и документа, на основании которого ведется разработка.
В разделе Назначение и область применения указывают назначение программы и дают краткую характеристику области применения.
Раздел Технические характеристики должен содержать следующие подразделы:
— постановка задачи, описание применяемых математических методов и допущений и ограничений, связанных с выбранным математическим аппаратом;
— описание алгоритмов и функционирования программы с обоснованием принятых решений;
— описание и обоснование выбора способа организации входных и выходных данных;
— описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов или анализов.
В разделе Ожидаемые технико-экономические показатели указывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения.
В разделе Источники, использованные при разработке, указывают перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в исходном тексте.
Пояснительная записка составляется профессионалами в области разработки программного обеспечения и для специалистов того же уровня квалификации. В ней необходимо использовать специальную терминологию, ссылаться на специальную литературу и т.п.
Руководство пользователя
В настоящее время используется Руководство пользователя, в которое входят руководство системного программиста, программиста и оператора. Этот документ появился с распространением персональных компьютеров, работая на которых пользователи совмещают в своем лице трех указанных специалистов.
Составление документации для пользователей имеет свои особенности, связанные с тем, что пользователь, как правило, не является профессионалом в области разработки программного обеспечения.
Рекомендации по написанию подобной программной документации:
— учитывайте интересы пользователей – руководство должно содержать все инструкции, необходимые пользователю;
— излагайте ясно, используйте короткие предложения;
— избегайте технического жаргона и узко специальной терминологии, если все же необходимо использовать некоторые термины, то их следует пояснить;
— будьте точны и рациональны – длинные и запутанные руководства обычно никто не читает, например, лучше привести рисунок формы, чем долго ее описывать.
Руководство пользователя содержит следующие разделы:
— общие сведения о программном продукте;
— описание установки;
— описание запуска;
— инструкции по работе (или описание пользовательского интерфейса);
— сообщения пользователю.
Раздел Общие сведения о программе обычно содержит наименование программного продукта, краткое описание его функций, реализованных методов и возможных областей применения.
Раздел Установка содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.
В разделе Запуск описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены.
Раздел Инструкция по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.
Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Руководство системного программиста
По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. В него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора и руководстве по техническому обслуживанию.
Руководство системного программиста должно содержать следующие разделы:
— общие сведения о программном продукте,
— сообщения системному программисту.
Раздел Общие сведения о программе должен включать описание назначения и функций программы, а также сведения о технических и программных средствах, обеспечивающих выполнение данной программы (например, объем оперативной памяти, требования к составу и параметрам внешних устройств, требования к программному обеспечению и т.п.).
В разделе Структура программы должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
В разделе Настройка программы должно быть приведено описание действий по настройке программы на условия практического применения.
В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.
В разделе Дополнительные возможности должно быть приведено описание дополнительных возможностей программы и способов доступа к ним.
В разделе Сообщения системному программисту должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки и проверки программы, а также в ходе его выполнения, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Дата добавления: 2020-11-29 ; просмотров: 450 ; Мы поможем в написании вашей работы!
Поделиться с друзьями:
Источник: studopedia.net
Функции, выполняемые программой
В данном программном документе приведено руководство программиста по настройке и использованию программы [[[«Mem.ехе», предназначенной для очистки и дефрагментации оперативной памяти ПК через заданные интервалы времени.]]]
В данном программном документе, в разделе «Назначение и условия применения программы» указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе «Характеристика программы» приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В данном программном документе, в разделе «Входные и выходные данные» приведено описание организации используемой входной и выходной информации.
В разделе «Сообщения» указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Оформление программного документа «Руководство программиста» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1), ГОСТ 19.103-77 2), ГОСТ 19.104-78* 3), ГОСТ 19.105-78* 4), ГОСТ 19.106-78* 5), ГОСТ 19.504-79* 6), ГОСТ 19.604-78* 7)).
Содержание
1. Назначение и условия применения программы.. 2
1.1. Назначение программы.. 2
1.2. Функции, выполняемые программой. 2
1.3. Условия, необходимые для выполнения программы.. 2
1.3.1. Объем оперативной памяти. 2
1.3.2. Требования к составу периферийных устройств. 2
1.3.3. Требования к параметрам периферийных устройств. 2
1.3.4. Требования к программному обеспечению.. 2
1.3.5. Требования к персоналу (программисту) 2
2. 2. Характеристика программы.. 2
2.1. Описание основных характеристик программы.. 2
2.1.1. Режим работы программы.. 2
2.1.2. Средства контроля правильности выполнения программы.. 2
2.2. Описание основных особенностей программы.. 2
2.2.1. Самовосстанавливаемость программы.. 2
3. Обращение к программе. 2
3.1. Загрузка и запуск программы.. 2
3.2. Выполнение программы.. 2
3.2.1. Выполнение функции (такой-то) 2
3.2.2. Выполнение функции (этакой) 2
3.3. Завершение работы программы.. 2
4. Входные и выходные данные. 2
4.1. Организация используемой входной информации. 2
4.2. Организация используемой выходной информации. 2
5.1. Сообщение (такое-то). 2
5.2. Сообщение (этакое). 2
Лист регистрации изменений. 2
Назначение и условия применения программы
Назначение программы
После многократного открытия и закрытия программ, записи в базы данных, считываний из них, а также в процессе работы SCADa-системы и ОС оперативная память значительно фрагментируется. В итоге команды будут обрабатываться на порядок медленнее.
У процессора в кэш (L1 и L2) записывается определенная часть оперативной памяти еще до того, как будет произведено обращение к этой области памяти. Когда же настает черед «прокэшированных» команд или данных, то они читаются процессором из КЭШа, что во много раз быстрее, чем обращение к оперативной памяти. Если запущенная программа и ее данные оказались фрагментированными в памяти, происходит ситуация, когда в кэш попадают совсем не те данные, которые нужны, и процессору ничего не остается, как отыскивать нужное в оперативной памяти. Подобное снижение hit rate КЭШа (число попаданий) способно снизить производительность, независимо от объема оперативной памяти.
Многие программы, в том числе и сама ОС, загружают в память множество библиотек (DLL) и не факт, что эти библиотеки будут обязательно использоваться. Поэтому необходимо подобные DLL выгружать в своп-файл. Если они вдруг понадобятся, то незамедлительно будут загружены ОС назад.
Действия по оптимизации и дефрагментации оперативной памяти производят программы сторонних разработчиков, такие как «FreeMemory» и «CoolMEM». В ходе их тестирования было установлено, что данные программы, в режиме постоянного мониторинга ОЗУ и очистке памяти при превышении заданных пределов, значительно загружают операционную систему и в некоторых случаях, приводят к зависанию ПК. В ходе изысканий было установлено, что при использовании программы «FreeMemory» (версии 1.7), при запуске её командной строкой с параметрами «С А» (С – очистка памяти, А — очистить всю память), после выполнения всех процедур по очистке и дефрагментации ОЗУ, данная программа полностью выгружается из памяти компьютера. При этом зависаний ПК не происходит и не используются лишние ресурсы компьютера. Используя эти данные, была разработана программа «Mem.exe», которая каждый час, командной строкой с параметрами «С А» загружает программу «FreeMemory», для очистки ОЗУ.
Программа «Mem.ехе» работает под управлением ОС Windows 98 или Windows Me.
Функции, выполняемые программой
Основной функцией программы «Mem.exe» является вызов из каталога C:Program FilesFreeMemory программы стороннего разработчика FreeMemory.exe с параметрами командной строки «С А» (С – очистка памяти, А — очистить всю память). Вызов программы производится по таймеру, каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно программа Mem.exe проверяет наличие по указанному пути (C:Program FilesFreeMemory) исполняемого модуля программы FreeMemory.exe, в случае его отсутствия, выдается сообщение «Файл FreeMemory.exe не найден, переустановите программу».
Основная задача вызываемой программы FreeMemory — повысить производительность системы.
Программа FreeMemory реализует следующие функции:
• Очистка и дефрагментация оперативной памяти
• Выгрузка ненужных DLL
Данные функции программы FreeMemory позволяют поддерживать бесперебойную работу ПК длительное время, предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и программами, а также в итоге предотвращать зависание ПК.
Источник: allrefrs.ru
1C — очищаем оперативную память по расписанию
1C сервер не хочет очищать за собой оперативную память. Автоматизируем процесс очистки.
Господин Wen Jia по фамилии Liu из Сиднея нам сильно помог, написав консольную утилиту EmptyStandbyList.exe, которую мы используем для автоматизации процесса ежедневной очистки оперативной памяти. Утилита работает в ОС Windows Vista и выше. Я проверял на Windows Server 2012 R2.
Утилита может очищать:
- process working sets
- the modified page list
- the standby lists (priorities 0 to 7)
- the priority 0 standby list only
EmptyStandbyList.exe workingsets|modifiedpagelist|standbylist|priority0standbylist
Сохраняем утилиту в папку, я сохраняю по адресу:
C:RAMEmptyStandbyList.exe
Пишем батник emptylist.bat:
echo off cd C:RAM EmptyStandbyList.exe workingsets EmptyStandbyList.exe standbylist exit
Сохраняем батник по адресу:
C:RAMemptylist.bat
Если запустить батник под администратором, то память очистится:
У меня эффект очистки слабо виден, но когда 1С забивает всю память, то ступенька круче.
Теперь создаём в Планировщике (Task Scheduler) новую задачу, которая каждый день в 7 утра будет запускать наш батник от имени локального администратора сервера.
Источник: internet-lab.ru