Пояснювальна записка до проекту асс тп. Технічна документація. Стандарти для пояснювальної записки

  • 03.03.2020

Пояснювальна записка до технічного проекту.

Основною метою створення ІС є прискорення «процесу продажу», а також підвищення оперативності роботи працівників. Для забезпечення працездатності системи на комп'ютерах, де вона використовується, має бути встановлено програмне забезпечення:

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

Нові дані вносяться до системи до початку роботи, це необхідно для введення початкових залишків. Для обмеження несанкціонованого внесення змін застосовується авторизація при вході до програми. Якщо пароль введено неправильно, система видасть повідомлення і дозволить з'єднатися з БД.

У системі реалізовано три основні завдання:

  • - ведення довідників;
  • - ведення складів;
  • - Реєстрація продажів;
  • - Виведення звітів.

Додаток БД для ІС розробляється з допомогою програмного середовища 1С: Підприємство 8. Для розміщення системи використовуються персональні комп'ютери, що є у ІП, котрого розробляється система.

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

Загальні вимоги до функціональності системи, що проектується, зображені за допомогою діаграми ВІ на малюнку 1

Таблиця -2 Головний розділ сценарію виконання ВІ «Додати дані довідників»

Редагувати дані довідників

Комірник, ІП

Підтримка в актуальному стані відомостей про об'єкти предметної галузі

Короткий опис

Користувач додає новий елемент довідника та записує його. Система зберігає змінені дані у БД

Передумова

  • 1. Користувач авторизований у системі.
  • 2. Користувач має права на додавання даних до довідника

Постуслів'я

  • 1. Елемент довідника записано БД.
  • 2. Елемент довідника відображено у формі списку довідника

Таблиця -3 Типовий перебіг подій сценарію виконання ВІ «Додати дані довідників»

Таблиця -4 Винятки сценарію виконання ВІ «Додати дані довідників»

Таблиця -5 Головний розділ сценарію виконання ВІ «Встановити ціни номенклатури»

Таблиця - 6 Типовий перебіг подій сценарію виконання ВІ «Встановити ціни номенклатури»

Таблиця -7 Винятки сценарію виконання ВІ «Встановити ціни номенклатури»

Таблиця -8 Головний розділ сценарію виконання ВІ «Зареєструвати надходження товарів»

Таблиця -9 Типовий перебіг подій сценарію виконання ВІ «Зареєструвати надходження товарів»

Дії акторів

Відгук системи

1. Комірник виконує команду створення нового документа «Надходження товарів»

2. Система відображає форму документа

3. Комірник заповнює реквізити шапки

Виняток №1: Комірник вручну заповнює поле Номер

4. Комірник додає новий рядок табличної частини на сторінці.

5. Система відображає новий рядок

6. Комірник заповнює колонку Номенклатура

7. Система підставляє значення колонок

8. Комірник заповнює колонку Кількість

9. Система розраховує значення колонок Сума,

10. Система відображає у підвалі табличної частини підсумкові значення колонок Всього

11. Комірник вводить новий товар(повернення до пункту 4) або виконує команду Записати

Виняток №2: Значення поля Номер не унікальний

12. Система записує новий документ«Надходження товарів» до БД

13. Комірник виконує команду Друк -

14. Система відображає заповнену друковану формуприбуткового ордера

15. Комірник виконує команду Друк

16. Система виводить на друк прибутковий ордер

17. Комірник виконує команду Закрити друковану форму

18. Система закриває друкарську форму

19. Комірник виконує команду Закрити документа «Надходження товарів»

20. Система закриває форму документа «Надходження товарів»

Таблиця -10 Винятки сценарію виконання ВІ «Зареєструвати надходження товарів»

Значення колонок сума та всього розраховуються за формулою:

Сума = Кількість * Ціна

Таблиця -11 розділ сценарію виконання ВІ «Здійснення продажів»

Таблиця -12 Типовий перебіг подій сценарію виконання ВІ «Здійснення продажів»

Дії акторів

Відгук системи

Оплата одного документа "продажів"

1. Менеджер виконує команду створення нового документа продажу

2. Система відображає форму документів продажів

4. Менеджер проводить документ

5. система проводить документ

9. Система виводить на друк

Таблиця - 13 Винятки сценарію виконання ВІ «Зареєструвати документ»

Таблиця -14 розділ сценарію виконання ВІ «Резервування»

Таблиця -15 Типовий перебіг подій сценарію виконання ВІ «Здійснення продажів»

Дії акторів

Відгук системи

Резервування товару

1. Менеджер виконує команду створення нового документа резервування

2. Система відображає форму документів "резервування"

3. Менеджер вносить дані про клієнта, про товар, що купується, і послуги, що купуються.

4. Менеджер проводить документ

Виняток №1 не всі поля заповнені

5. система проводить документ

6. менеджер виконує команду Друк

7. Система відображає заповнену друкарську форму

8. Менеджер виконує команду Друк

9. Система виводить на друк

10. Менеджер виконує команду Закрити друковану форму

11. Система закриває друкарську форму

11. Менеджер виконує команду Закрити документ «Надання послуг»

12. Система закриває форму документа

Таблиця - 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 - Робочий стіл для користувача за участю «Менеджер»

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

Міністерство економічного розвиткута торгівлі Російської Федерації

ЗАТВЕРДЖУЮ

Державний контракт № 000-05-07 від «29» жовтня 2007 р., укладений між Міністерством економічного розвитку та торгівлі Російської Федерації та ЗАТ «ПРОГНОЗ», на виконання робіт на тему «Розробка автоматизованого модуля федерального моніторингу соціально-економічного розвитку суб'єктів Російської Федерації у рамках створення єдиної інформаційної системимоніторингу ключових показниківсоціально-економічного розвитку Російської Федерації та контролю результативності діяльності органів державної владищодо їх досягнення».

При розробці цього документа використовувався Керівний документ стандартизації ГОСТ РД 50-34.698-90.

1. загальні положення.. 5

1.1. Повне найменування системи... 5

1.2. Документи, на підставі яких ведеться проектування.

1.3. Стадії та терміни виконання.

1.4. Цілі та призначення.

1.5. Відповідність проектних рішень вимогам безпеки.

1.6. Нормативно-технічні документи... 9

2. Опис процесу діяльності.

2.1. Перелік завдань. 10

2.2. Основні функції, що виконуються Модулем... 11

3. Основні технічні рішення.

3.1. Структура Модуля, перелік підсистем... 13

3.1.1. Підсистема централізованого сховища даних. 14

3.1.2. Інтерфейсний компонент. 15

3.1.3. Адаптерні програмні компоненти. 16


3.6.3. Ступінь пристосовності до відхилень параметрів об'єкта автоматизації. 26

3.6.4. Допустимі межі модернізації та розвитку системи.

3.6.5. Вимоги до надійності. 27

3.6.6. Вимога безпеки. 27

3.6.7. Вимоги до ергономіки та технічної естетики. 28

Перелік робіт

Очікувані результати робіт

Розробка Централізованого сховища даних (ЦХД) соціально-економічної інформації, що використовується при здійсненні федерального моніторингу показників соціально-економічного розвитку (ПСЕР) суб'єктів Російської Федерації та муніципальних утворень

Підсистема Централізованого сховища даних

Розробка схем даних ПСЕР та профілів технологічних специфікацій, що описують протоколи взаємодії з інтерфейсною компонентою та формати публікованих даних ПСЕР

Схеми даних ПСЕР та профілі технологічних специфікацій, що описують протоколи взаємодії з інтерфейсною компонентою та формати даних ПСЕР;

Звіт про обговорення проектів специфікацій на схеми даних та профілів технологічних специфікацій, із зафіксованими зауваженнями та пропозиціями учасників обговорення.

Розробка, апробація на пілотних об'єктах впровадження та доопрацювання відповідно до виявлених зауважень, кроссплатформенного програмного забезпечення інтерфейсної компоненти

Інтерфейсні компоненти

Обов'язкова адаптерна компонента

Розробка специфічних адаптерних компонентів, що забезпечують автоматизоване отримання інформації про СЕР з успадкованих АІС джерел даних та її публікацію через інтерфейсну компоненту відповідно до її специфікацій. Специфічні адаптери повинні містити блок верифікації та перевірки достовірності статистичної інформації

специфічні адаптерні компоненти;

Регламент автоматичного збору інформації, що використовується при здійсненні федерального моніторингу та поставляється з web-сайтів та з АІС федеральних міністерств та відомств, суб'єктів Російської Федерації, муніципальних утвореньвідповідно до розроблених специфікацій вихідних параметрів, призначених для надання інформації цими джерелами даних

Розробка засобів табличного, графічного, картографічного, текстового представлення результатів моніторингу та аналізу соціально-економічного розвитку суб'єктів Російської Федерації.

Підсистема табличного, графічного, картографічного, текстового представлення даних моніторингу та результатів аналізу соціально-економічного розвитку суб'єктів Російської Федерації

Розробка підсистеми Модуля, призначеної для розрахунку критеріїв оцінки розвитку секторів економіки суб'єктів федерації на основі інформації, що збирається у процесі федерального моніторингу

Підсистема розрахунку критеріїв оцінки розвитку секторів економіки суб'єктів Російської Федерації (з можливістю виявлення регіональних кластерів) на основі інформації, що збирається у процесі федерального моніторингу

Розробка підсистеми Модуля, призначеної для розрахунку інтегральних індексів та оцінок соціально-економічного розвитку суб'єктів федерації на основі інформації, що збирається у процесі федерального моніторингу

Підсистема розрахунку інтегральних індексів та оцінок соціально-економічного розвитку суб'єктів Російської Федерації на основі інформації, що збирається в процесі федерального моніторингу

Розробка підсистеми Модуля, призначеної для публікації інформації про СЕР відповідно до вимог чинних нормативних актів та розроблених у рамках проекту, а також специфікацій на інтерфейсну компоненту

Підсистема публікації у відкритому доступі первинної та перетвореної інформації про СЕР, що зберігається в Модулі.

Розробка підсистеми адміністрування

Підсистема адміністрування

Повний пакет проектної документації для Модуля федерального моніторингу відповідно до вимог ГОСТ 34

Проведення приймально-здавальних випробувань, доробка Модуля відповідно до зауважень Замовника

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

Пояснювальна записка необхідна для відображення інформації про об'єкт, прийняті технічні рішення та їх обґрунтування.

Склад пояснювальної записки

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

  1. Вступ. У цьому розділі вказується назва об'єкта або системи, тема розробки та перелік документів – фундаменту для початку роботи. Основна документація, наведена у Вступі:
  2. документ певного (федерального, відомчого, регіонального) рівня, що дозволяє розробку проекту; вирішення відповідних органів; рішення інвестора.

    Також до цього розділу входить:

    завдання проектування (якщо проект розробляється з урахуванням договору); документи, що встановлюють право власності на об'єкт капітального будівництва(якщо проектна документаціярозробляється для виконання реконструкції чи ремонту об'єкта); звіти за підсумками інженерних досліджень та випробувань; затверджений план земельної ділянки, що відведена під забудову; документи використання земельних ділянок, які під вплив містобудівних регламентів, отримані від уповноважених органів федеральної, виконавчої чи місцевої влади; технічні умови та документи, що дозволяють відступ від них; акти власника об'єкта про необхідний знесення деяких споруд із території будівництва; дозвіл відхилення від граничних величин об'єктів капітального будівництва.
  3. Функціональність, призначення об'єкта, подальша експлуатація. У цьому розділі характеризуються цілі, завдання та сфера використання об'єкта, що розробляється.
  4. Технічні характеристики. Це найбільший розділ, що складається з взаємопов'язаних підрозділів. До цього розділу входять:
  5. дані щодо необхідності забезпечення об'єкта газом, водою, паливом та електроенергією; відомості про проектну потужність (для промислових об'єктів); інформація про обсяги необхідної сировини, води, паливних та енергетичних ресурсівта дані про їх користування (для виробничих об'єктів); відомості про вилучені ділянки (у тимчасове чи постійне користування), обґрунтування їх розмірів, якщо вони не регламентовані нормами; у разі вилучення земель під тимчасове або постійне застосування дані про величину матеріальних засобів, необхідних для відшкодування збитків їх власникам; характеристика категорії земель, що відведені під забудову; дані про наявні спеціальні технічних умов(у разі необхідності).
  6. Техніко-економічні показники – відображена інформація про проектну потужність ГКС, значущість його для населення, кількість майбутніх співробітників, кількість робочих місць тощо.
  7. Також цьому етапі можлива характеристика комп'ютерних програм, застосованих розробки проекту. Наводяться відомості про можливі витрати на знесення будівель і споруд, переселення людей, переміщення комунікацій, конструкцій і т. д. (якщо необхідно). Виконується опис та обґрунтування можливості реалізації стадійного будівництва об'єкта, виділення етапів (за потреби).

    Розділ ПЗ в обов'язковому порядку має містити підтвердження проектної організаціїтого, що вся документація розроблена та оформлена згідно з документами:

    містобудівному плану земельної ділянки; завдання на проектування; містобудівному регламенту; інших технічних регламентівта вимог.
  8. Список літератури. У цьому розділі наводяться джерела, документи, статті, книги, посилання, на які вказувалися в текстовій частині проекту.

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

Графічна частина ПЗ представляється відповідними кресленнями кращого сприйняття попередньо написаної текстової інформації. У цей підрозділ включають загальний генплан місцевості з транспортними комунікаціями та інженерними мережами, на який накладається об'єкт, що проектується; докладне креслення власне об'єкта проектування (для виробничих об'єктів необхідно наносити також технологічні процеси); схеми електропостачання, теплопостачання тощо.

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

Як правило, Пояснювальна записка буває найскладнішим документом на програмне забезпечення, часом викликаючи безліч суперечок і дискусій навколо свого змісту. Чому так трапляється?

Призначення пояснювальної записки

Ми вже говорили про те, що у розробці програмного забезпечення- Це один з важливих етапів. У ньому має бути представлений опис вашої системи з урахуванням вибраних технологій, як від нас цього вимагає ДЕРЖСТАНДАРТ 34. А документ Пояснювальна записка до технічному проекту, або, скорочено, ПЗ є одним з основних документів даного етапу. І, треба сказати, найчастіше саме Пояснювальна записка буває найскладнішим документом на ПЗ, часом викликаючи велику кількість суперечок і дискусій навколо свого змісту.

Склад типової пояснювальної записки

Пояснювальна записка до технічного проекту включає такі розділи, як:

Вступ. У цьому розділі наводиться повне найменування системи та тема розробки, а також список документів, що стали підставою для робіт з проекту.

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

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

Очікувані техніко-економічні показники. Розділ передбачає економічне обґрунтування розробки з урахуванням її технічних показників.

Джерела, використані для розробки. Розділ є список документів, статей та публікацій, на які були наведені посилання в тексті.

Стандарти для пояснювальної записки

Склад розділів визначається ГОСТом 19.404, однак стандарт дозволяє ці розділи при необхідності об'єднувати, а також додавати нові. У разі використання ГОСТ серії 34 слід розробляти документ відповідно до РД 50-34.698. Тим не менш, документ повинен залишатися в рамках вимог загальних стандартів, таких як, наприклад, ГОСТ 19.105.

Вартість розробки пояснювальної записки

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

- з одного боку, виразно і зрозуміло представляє всі необхідні (а часом і нудні) відомості, включаючи складні технічні подробиці;

Приклад «Пояснювальна записка» (П2 по), розробленого для автоматизованої вимірювально-інформаційної системи комерційного обліку електроенергії (АІІС КУЕ) згідно з документом. з в. Редакція від 20.06.2018.

Пояснювальна записка (П2 за ГОСТ 34.201-89) автоматизованої вимірювально-інформаційної системи комерційного обліку електроенергії (АІІС КУЕ) (приклад)

Створено 25.03.2014 11:48:18

Увага! Технічні вимогиоптового ринку електроенергії (ОРЕ), посилання на пункти яких містяться у прикладах документів на автоматизовані вимірювально-інформаційні системи комерційного обліку електроенергії (АІІС КУЕ), змінюються досить часто, але не нами, а адміністратором торгової системи (АТС). Прохання поставитися до цього з розумінням

Усі документи бойові, що пройшли безліч, включаючи експертизи у ФГУП «Всеросійський науково-дослідний інститут стандартизації та сертифікації в машинобудуванні» (ВНІІМАШ) РОСТАНДАРТУ, тому сумніву не підлягає.

Для отримання безкоштовноюскороченої версії будь-якого у вигляді *.pdf достатньо клацнути на титульний лист. Документ відкриється в браузері з можливістю. Повні версіїдокументів – платні, їх можна отримати у форматі за певну суму, скориставшись. Будь-який документ може протягом деякого часу бути доопрацьований під конкретні вимоги замовника. Умови обговорюються.