Как правило, Пояснительная записка бывает самым сложным документом на ПО, подчас вызывая множество споров и дискуссий вокруг своего содержания. Почему так случается?

Назначение пояснительной записки

Мы уже говорили о том, что в разработке программного обеспечения – это один из важных этапов . В нем должно быть представлено описание вашей системы с учетом выбранных технологий, как от нас того требует ГОСТ 34. А документ Пояснительная записка к техническому проекту, или, сокращенно, ПЗ, является одним из основных документов данного этапа. И, надо сказать, чаще всего именно Пояснительная записка бывает самым сложным документом на ПО, подчас вызывая множество споров и дискуссий вокруг своего содержания.

Состав типовой пояснительной записки

Пояснительная записка к техническому проекту включает в себя такие разделы, как:

– Введение . В этом разделе приводится полное наименование системы и тема разработки, а также список документов, послуживших основанием для работ по проекту.

– Назначение и область применения . Здесь описываются цели и задачи, которые будут решены с помощью системы, а также сфера ее использования.

– Технические характеристики . Этот раздел обычно разбивают на подразделы, в которых описывают: постановку задачи на создание программы; используемый математический аппарат; алгоритм работы ПО; структуру входных и выходных данных; состав технических и программных средств. Также необходимо приводить расчеты и результаты анализа для обоснования выбора именно тех решений, о которых говорится в документе.

– Ожидаемые технико-экономические показатели . Раздел предполагает экономическое обоснование разработки с учетом ее технических показателей.

– Источники, использованные при разработке . Раздел представляет собой список документов, статей и публикаций, на которые были приведены ссылки в тексте.

Стандарты для пояснительной записки

Состав разделов определяется ГОСТом 19.404, однако, стандарт позволяет эти разделы при необходимости объединять, а также добавлять новые. В случае использования ГОСТ серии 34 следует разрабатывать документ в соответствии с РД 50-34.698. Тем не менее, документ должен оставаться в рамках требований общих стандартов, таких, например, как ГОСТ 19.105.

Стоимость разработки пояснительной записки

Как же с наименьшими затратами создать документ на программу, максимально полезный для вашего проекта, который:

– с одной стороны, внятно и доходчиво представляет все нужные (а порой и нудные) сведения, включая сложные технические подробности;

Пояснительная записка к техническому проекту.

Основной целью создания ИС является ускорение «процесса продаж», а также повышение оперативности работы сотрудников. Для обеспечения работоспособности системы на компьютерах, где она используется должно быть установлено программное обеспечение:

• - ос семейства Windows;
• - 1С: Предприятие 8;

Новые данные вносятся в систему до начала работы, это необходимо для ввода начальных остатков. Для ограничения несанкционированного внесения изменений применяется авторизации при входе в программу. Если пароль введен неверно, то система выдаст сообщение и не позволит соединиться с БД.

В системе реализованы три основные задачи:

• - ведение справочников;
• - ведение складов;
• - регистрация продаж;
• - вывод отчетов.

Приложение БД для ИС разрабатывается с помощью программной среды 1С: Предприятие 8. Для размещения системы используются персональные компьютеры, имеющиеся у ИП, для которого разрабатывается система.

Схема функциональной структуры

Общие требования к функциональности проектируемой системы изображены с помощью диаграммы ВИ на рисунке 1

Таблица -2 Главный раздел сценария выполнения ВИ «Добавить данные справочников»

Таблица -3 Типичный ход событий сценария выполнения ВИ «Добавить данные справочников»

Таблица -4 Исключения сценария выполнения ВИ «Добавить данные справочников»

Таблица -5 Главный раздел сценария выполнения ВИ «Установить цены номенклатуры»

Таблица - 6 Типичный ход событий сценария выполнения ВИ «Установить цены номенклатуры»

Таблица -7 Исключения сценария выполнения ВИ «Установить цены номенклатуры»

Таблица -8 Главный раздел сценария выполнения ВИ «Зарегистрировать поступление товаров»

Таблица -9 Типичный ход событий сценария выполнения ВИ «Зарегистрировать поступление товаров»

Таблица -10 Исключения сценария выполнения ВИ «Зарегистрировать поступление товаров»

Значения колонок сумма и всего рассчитываются по формуле:

Сумма = Количество * Цена

Таблица -11 раздел сценария выполнения ВИ «Совершение продаж»

Таблица -12 Типичный ход событий сценария выполнения ВИ «Совершение продаж»

Таблица - 13 Исключения сценария выполнения ВИ «Зарегистрировать документ»

Таблица -14 раздел сценария выполнения ВИ «Резервирование»

Таблица -15 Типичный ход событий сценария выполнения ВИ «Совершение продаж»

Таблица - 16 Исключения сценария выполнения ВИ «Зарегистрировать документ»

Таблица -17 ВИ «Сформировать отчет»

Разработка структуры справочников

Справочник «Контрагенты» предназначен для хранения информации о клиентах, поставщиках.

Таблица -15 Реквизиты справочника Клиенты

Правовой статус имеет тип перечисление. Это значит что при выборе этого поля будет выпадать список из трех статусов: ИП, Физ. Лицо, Организация.

Создание справочника «Сотрудники» . Предназначен для хранения информации о сотрудниках организации. Позволяет привязывать продажу к конкретному сотруднику.

Таблица -16 Реквизиты справочника Сотрудники

Создание справочника «Склады» . Предназначен для определения места хранения товара. У ИП будут два склада это ТорговаяТочка1 и ТорговаяТочка2.

Создание справочников «Вариант Номенклатуры» и «Дополнительные Свойства» . Эти справочники предназначены для определения дополнительных характеристик для конкретной номенклатуры, то есть мониторы могут быть идентичные, но будут различаться цвета. Эти справочники будут вызываться в форме справочника номенклатура. Значение этих полей отображается в документе «Продажи».

Создание справочника «Номенклатура» . Для учета товаров, приобретаемых у поставщика, создадим справочник «Номенклатура».

Товары в справочнике Номенклатура будут объединяться в группы по функциональному назначению, поэтому справочник будет иметь вид иерархии «иерархия групп и элементов».

Таблица -17 Реквизиты справочника Номенклатура

Разработка структуры регистра сведений «Цены номенклатуры»

Для хранения стоимости номенклатурных единиц создадим регистр сведений с именем «Цены». Периодичность регистра - в пределах секунды (т.е. цены можно отслеживать в течение любого момента времени), режим записи - независимый.

Таблица -18 Структура регистра сведений Цены

Свойство Ведущее говорит о том, что запись регистра сведений представляет интерес, пока существует тот объект, ссылка на который выбрана в качестве значения этого измерения в этой записи. При удалении объекта все записи регистра сведений по этому объекту будут автоматически удалены.

Разработка структуры документа «Поступление товаров»

Документ «Поступление товаров» предназначен для отражения факт поступления в организацию приобретенных товаров.

Таблица-19 реквизиты документа «Поступление Товаров (Приходная Накладная)»

Таблица -19 Реквизиты табличной части документа «ПоступлениеТоваров»

Написан код для автоматического расчета значений колонок Сумма, при изменении значений колонок Количество, Цена.

Форма документа будет иметь вид, изображенный на рисунке 2

Рисунок 2- Форма документа Поступление товаров

Разработка структуры документа «Продажи»

Документ оказание услуг предназначен для фиксации деятельности ИП. Он контролирует списание товаров, услуги которые были совершены, также позволяет просматривать отчет о работе сотрудников.

Таблица -20 Реквизиты документа «Продажи»

Таблица -21 Реквизиты табличной части документа Продажи

Разработка структуры документа «Резервирование»

Документ «Резервирование» предназначен для бронирования существующего товара на складе, и в случае нехватки занять за клиентом недостающую часть товара. Также он необходим для резервирования товара до момента оплаты стоимости заказа клиентом. Этот документ призван контролировать остатки на складах, дабы избежать недоразумений с клиентом.

Таблица -20 Реквизиты документа «Резервирование»

Таблица -21 Реквизиты табличной части документа Резервирование

Разработка структуры документа «Ввод начальных остатков»

Этот документ необходим для ввода в базу данных начальных остатков.

Его реквизиты схожи с документом «Приходная накладная».

Создание отчета «Товары»

Отчет «Товары» предназначен для быстрого просмотра списания и поступления товаров. То есть он позволяет пользователю просматривать сколько на данный момент находится номенклатуры, сколько продано.

В среде 1С Предприятие 8 есть построитель отчетов, который позволяет быстро разрабатывать отчет, формируя на основе таблиц запросы и оформление.

Создание отчета «РеестрДокументовПродажи»

Этот отчет предназначен для формирования реестра документов «продаж». Также в системе будут реализованы различные отчеты, которые будут схожи по структуре создания.

Создание ролей и назначение их пользователям

Администрирование списка пользователей 1С:Предприятия и назначение им ролей в соответствии с их служебными обязанностями - очень важные моменты для организации интерфейса прикладного решения в целом и разграничения прав и действий его отдельных пользователей.

Следует ограничить пользователей в выполнении действий с объектами базы данных. Так, кладовщик может создавать документы «Поступление товаров» и записывать документы, поскольку он отвечает за регистрацию поступления товаров. Менеджер же в свою очередь должен иметь доступ к добавлению справочников клиентов, оформления документа «продажи», «резервировании», но в то же время он не должен иметь доступа к поступлению товаров.

Для описания подобных разрешений используются объекты конфигурации Роль. Каждому пользователю системы ставится в соответствия одна или несколько ролей.

При создании ролей исходят из того, какие полномочия требуются различным группам пользователей на доступ к информации. В нашей систему будут реализованы следующие роли:

• - администратор - в системе 1С:Предприятие должна присутствовать роль, включающая в себя полные права на работу с данными ИБ;
• - кладовщик;
• - менеджер;
• - ИП.

Присвоение ролей пользователям осуществляется через пункт главного меню Администрирование -> Пользователи.

Рисунок 3 - Создание пользователя «Администратор» с ролью «Администратор»

Рисунок 4 - Список пользователей системы

Для всех объектов базы данных для всех ролей исключено право интерактивного удаления.

Редактирование командного интерфейса разделов и рабочего стола

Усовершенствование командного интерфейса приложения, настройка видимости команд по ролям и рабочего стола делает приложение более удобным для пользователей и придает ему завершенный вид.

Рассортируем команды в зависимости от приоритета и частоты использования по следующим группам:

• - панель навигации.Важное;
• - панель навигации.Обычное;
• - панель навигации.См. также;
• - панель действий.Создать и
• - панель действий.Отчеты

Рисунок 5 - Командный интерфейс раздела «Учет материалов» пользователя с ролью «Кладовщик»

Рисунок 6 - Командный интерфейс раздела «ОказаниеУслуг» пользователя с ролью «Менеджер»

Рисунок 7 - Командный интерфейс раздела «Предприятие» пользователя с ролью «Директор»

Рисунок 8 - Командный интерфейс раздела «Розницы.Электроник» пользователя с ролью «Администратор»

Рабочий стол предназначен для размещения наиболее часто используемых пользователем документов, отчетов, справочников и т.п. При запуске 1С:Предприятия раздел Рабочий стол становится активным по умолчанию и нужные формы сразу открываются в рабочей области приложения.

Рисунок 9 - Рабочий стол для пользователя с ролью «Кладовщик»

Рисунок 10 - Рабочий стол для пользователя с ролью «Менеджер»

автоматизация оптовая торговля программный документация

ГОСТ 19.404-79

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

Требования к содержанию и оформлению

Unified system for program documentation. Explanatory note. Requirements for contents and form of presentation

Дата введения 1981-01-01

Постановлением Государственного комитета CCCР по стандартам от 11 декабря 1979 г. N 4753 дата введения установлена 01.01.81

ПЕРЕИЗДАНИЕ. Январь 2010 г.


Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Пояснительная записка", определенного ГОСТ 19.101-77 , входящего в состав документов на стадиях разработки эскизного и технического проектов программы.

1. ОБЩИЕ ПОЛОЖЕНИЯ

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) является необязательным.

1.2. Пояснительная записка должна содержать следующие разделы:

введение;

назначение и область применения;

технические характеристики;

ожидаемые технико-экономические показатели;

источники, использованные при разработке.

В зависимости от особенностей документа отдельные разделы (подразделы) допускается объединять, а также вводить новые разделы (подразделы).

2.1. В разделе "Введение" указывают наименование программы и (или) условное обозначение темы разработки, а также документы, на основании которых ведется разработка, с указанием организации и даты утверждения.

2.2. В разделе "Назначение и область применения" указывают назначение программы, краткую характеристику области применения программы.

2.3. Раздел "Технические характеристики" должен содержать следующие подразделы:

постановка задачи на разработку программы, описание применяемых математических методов и, при необходимости, описание допущений и ограничений, связанных с выбранным математическим аппаратом;

описание алгоритма и (или) функционирования программы с обоснованием выбора схемы алгоритма решения задачи, возможные взаимодействия программы с другими программами;

описание и обоснование выбора метода организации входных и выходных данных;

описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов и (или) анализов, распределение носителей данных, которые использует программа.

2.4. В разделе "Ожидаемые технико-экономические показатели" указывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения, а также, при необходимости, ожидаемые оперативные показатели.

2.5. В разделе "Источники, использованные при разработке" указывают перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте.

2.6. В приложение к документу могут быть включены таблицы, обоснования, методики, расчеты и другие документы, использованные при разработке.



Электронный текст документа
подготовлен ЗАО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сб. ГОСТов. -
М.: Стандартинформ, 2010

Пояснительная записка (ПЗ) – это из один важнейших пунктов Технического проекта, который несет в себе полное описание и характеристики выбранных технологий, обуславливающих вид и конструкцию исследуемой системы.

Пояснительная записка необходима для отражения информации об объекте, принятых технических решениях и их обоснования.

Состав пояснительной записки

Пояснительная записка к проекту любого ОКС вмещает подразделы:

1. Введение. В этом разделе указывается название объекта или системы, тема разработки и перечень документов – фундамента для начала работ. Основная документация, приведенная во Введении:
документ определенного (федерального, ведомственного, регионального) уровня, разрешающий разработку проекта; решение соответствующих органов; решение инвестора.

Также в данный раздел входит:

задание на проектирование (если проект разрабатывается на основе договора); документы, устанавливающие право собственности на объект капитального строительства (если проектная документация разрабатывается для выполнения реконструкции или ремонта объекта); отчеты по итогам инженерных исследований и испытаний; утвержденный план земельного участка, отведенного под застройку; документы на использование земельных участков, не попадающих под влияние градостроительных регламентов, полученные от уполномоченных органов федеральной, исполнительной или местной власти; технические условия и документы, разрешающие отступление от них; акты владельца объекта о необходимом сносе некоторых сооружений с территории строительства; разрешение на отклонение от граничных величин объектов капитального строительства.
2. Функциональность, назначение объекта, дальнейшая эксплуатация. В данном разделе характеризуются цели, задачи и сфера использования разрабатываемого объекта.
3. Технические характеристики. Это самый объемный раздел, состоящий из взаимосвязанных подразделов. В данную главу входят:
данные о необходимости обеспечения объекта газом, водой, топливом и электроэнергией; сведения о проектной мощности (для промышленных объектов); информация об объемах необходимого сырья, воды, топливных и энергетических ресурсов и данные об их пользовании (для производственных объектов); сведения об изъятых участках (во временное или постоянное пользование), обоснование их размеров, если они не регламентированы нормами; в случае изъятия земель под временное или постоянное применение – данные о величине материальных средств, необходимых для возмещения убытков их обладателям; характеристика категории земель, отведенных под застройку; данные об имеющихся специальных технических условиях (в случае необходимости).
4. Технико-экономические показатели – отражена информация о проектной мощности ОКС, значимости его для населения, количестве будущих сотрудников, числе рабочих мест и т. д.

Также на этом этапе возможна характеристика компьютерных программ, примененных при разработке проекта. Приводятся сведения о вероятных затратах на снос зданий и сооружений, переселении людей, перемещении коммуникаций, конструкций и т. д. (если необходимо). Выполняется описание и обоснование возможности реализации стадийного строительства объекта, выделение этапов (при необходимости).

Раздел ПЗ в обязательном порядке должен содержать подтверждение проектной организации того, что вся документация разработана и оформлена согласно документам:

градостроительному плану земельного участка; задания на проектирование; градостроительному регламенту; других технических регламентов и требований.
5. Список литературы. В этом разделе приводятся источники, документы, статьи, книги, ссылки на которые указывались в текстовой части проекта.

Также в пояснительной записке содержится текстовая информация по обоснованию принятых технологических и технических решений, показатели по генеральному плану, внутреннему и внешнему транспорту и т. д.

Графическая часть ПЗ представляется соответствующими чертежами для лучшего восприятия предварительно написанной текстовой информации. В этот подраздел включают общий генплан местности с транспортными коммуникациями и инженерными сетями, на который накладывается проектируемый объект; подробный чертеж собственно объекта проектирования (для производственных объектов необходимо наносить также технологические процессы); схемы электроснабжения, теплоснабжения и т. д.

Наша компания выполнит пояснительную записку к проекту на строительство, капитальный ремонт или реконструкцию объекта жилого или производственного значения по установленным нормам и требованиям. Наша помощь поможет Вам проблем и задержек при согласовании проекта в различных инстанциях и обеспечит быстрое получение разрешения на строительство.