Explanatory note to the project ACS TP. Technical documentation. Standards for explanatory note

Explanatory note to the technical project.

The main purpose of creating an IS is to speed up the "sales process", as well as increase the efficiency of employees. To ensure the operability of the system, the following software must be installed on the computers where it is used:

• - OS of the Windows family;
• - 1C: Enterprise 8;

New data is entered into the system before the start of work, this is necessary to enter the initial balances. To limit unauthorized changes, authorization is used when entering the program. If the password is entered incorrectly, the system will display a message and will not allow you to connect to the database.

The system has three main tasks:

• - maintenance of directories;
• - maintaining warehouses;
• - registration of sales;
• - output of reports.

The DB application for IP is developed using the 1C: Enterprise 8 software environment. To host the system, personal computers are used that are available to the individual entrepreneur for whom the system is being developed.

Scheme functional structures

The general requirements for the functionality of the system being designed are shown using the VI diagram in Figure 1

Table -2 The main section of the VI execution script "Add directory data"

	Edit directory data
	Storekeeper, IP
	Maintaining up-to-date information about the objects of the subject area
Short description	The user adds a new directory element and writes it down. The system saves the changed data in the database
Precondition	1. The user is authorized in the system. 2. The user has the rights to add data to the directory
postcondition	1. The directory element is written to the database. 2. The directory element is displayed in the form of a directory list

Table -3 Typical course of events of the VI execution scenario "Add directory data"

Table -4 Exclusions of the VI execution scenario "Add directory data"

Table -5 The main section of the VI execution script "Set item prices"

Table - 6 Typical course of events of the VI execution scenario "Set item prices"

Table -7 Exclusions of the VI execution scenario "Set item prices"

Table -8 The main section of the VI execution scenario "Register the receipt of goods"

Table -9 Typical course of events of the VI execution scenario "Register receipt of goods"

Actor actions	System response
1. The storekeeper executes the command to create a new document "Receipt of goods"	2. The system displays the document form
3. The storekeeper fills in the details of the header Exception #1: Storekeeper manually fills in the Number field
4. The storekeeper adds a new row in the tabular section on the Products page	5. The system displays a new line
6. The storekeeper fills in the Nomenclature column	7. The system substitutes the value of the columns
8. The storekeeper fills in the Quantity column	9. The system calculates the value of columns Amount,
10. The system displays in the footer of the tabular part the total values ​​of the columns Total
11. The storekeeper enters new product(return to step 4) or execute the Write command Exception #2: The value of the Number field is not unique	12. The system is recording new document"Receipt of goods" in the database
13. The storekeeper executes the command Print -	14. The system displays the completed printed form receipt order
15. The storekeeper executes the Print command	16. The system prints out the receipt order
17. The storekeeper executes the command Close the printing form	18. The system closes the printing plate
19. The storekeeper executes the command Close the document "Receipt of goods"	20. The system closes the form of the document "Receipt of goods"

Table -10 Exceptions for the execution scenario of the VI "Register the receipt of goods"

The values ​​of the sum and total columns are calculated by the formula:

Amount = Quantity * Price

Table -11 section of the scenario for the execution of the VI "Make sales"

Table -12 Typical course of events of the scenario for the execution of the VI "Make sales"

Actor actions	System response
Payment for one "sales" document
1. The manager executes the command to create a new sales document	2. The system displays the form of "sales" documents
4. Manager posting the document
5. The system holds the document
9. The system prints

Table - 13 Exceptions of the VI execution scenario "Register document"

Table -14 section of the script for the execution of VI "Reservation"

Table -15 Typical course of events of the scenario for the execution of the VI "Making Sales"

Actor actions	System response
Product reservation
1. The manager executes the command to create a new reservation document	2. The system displays the form of "reservation" documents
3. The manager enters data about the client, the purchased product and purchased services
4. Manager posting the document Exception #1 not all fields are filled	5. The system holds the document
6. The manager executes the Print command	7. The system displays the completed printable
8. The manager executes the Print command	9. The system prints
10. The manager executes the command Close the printing form	11. The system closes the printing plate
11. The manager executes the command Close the document "provision of services"	12. The system closes the document form

Table - 16 Exceptions of the VI execution scenario "Register document"

Table -17 VI "Create a report"

Development of the directory structure

Directory "Contractors" designed to store information about customers, suppliers.

Table -15 Details of the reference book Clients

Legal status is of type enum. This means that when this field is selected, a list of three statuses will appear: IP, Physical. Person, Organization.

Creation directory "Employees". Designed to store information about the employees of the organization. Allows you to link a sale to a specific employee.

Table -16 Details of the directory Employees

Creation directory "Warehouses". Designed to determine the storage location of goods. The IP will have two warehouses - Trading Point 1 and Trading Point 2.

Creation directories "Option Items» and "Additional Properties". These references are intended to define additional characteristics for a particular nomenclature, that is, monitors may be identical, but colors will differ. These directories will be called in the form of the nomenclature directory. The value of these fields is displayed in the "Sales" document.

Creation directory "Nomenclature". To account for goods purchased from a supplier, we will create a reference book "Nomenclature".

Items in the Nomenclature directory will be combined into groups according to their functional purpose, so the directory will have the form of a hierarchy "hierarchy of groups and elements".

Table -17 Requisites of the reference book Nomenclature

Development of the structure of the information register "Nomenclature prices"

To store the cost of nomenclature units, we will create a register of information with the name "Prices". The frequency of the register is within a second (ie prices can be tracked for any moment in time), the recording mode is independent.

Table -18 Structure of the information register Prices

The Leading property indicates that the information register entry is of interest as long as the object whose reference is selected as the value of this dimension in this entry exists. When an object is deleted, all information register entries for this object will be automatically deleted.

Development of the structure of the document "Receipt of goods"

The document "Receipt of goods" is intended to reflect the fact of receipt of purchased goods by the organization.

Table-19 details of the document "Receipt of Goods (Receipt Invoice)"

Table -19 Details of the tabular part of the document "Receipt of Goods"

A code was written to automatically calculate the values ​​of the columns Amount, when changing the values ​​of the columns Quantity, Price.

The form of the document will look like shown in Figure 2

Figure 2- Document form Receipt of goods

Development of the structure of the document "Sales"

The document for the provision of services is intended to record the activities of an individual entrepreneur. It controls the write-off of goods, services that have been completed, and also allows you to view a report on the work of employees.

Table -20 Details of the document "Sales"

Table -21 Details of the tabular section of the Sales document

Development of the structure of the document "Reservation"

The "Reservation" document is intended for booking existing product in the warehouse, and in case of shortage, take the missing part of the goods for the client. It is also necessary to reserve the goods until the customer pays the cost of the order. This document is designed to control stock balances in order to avoid misunderstandings with the client.

Table -20 Details of the document "Reservation"

Table -21 Details of the tabular part of the document Reservation

Development structures document "Input primary remnants"

This document is required to enter the initial balances into the database.

Its details are similar to the document "Receipt invoice".

Creation report "Products"

The Goods report is designed to quickly view the write-off and receipt of goods. That is, it allows the user to view how many items are currently located, how many have been sold.

In the 1C Enterprise 8 environment, there is a report builder that allows you to quickly develop a report by generating queries and design based on tables.

Creation report "Register of Documents of Sale"

This report is designed to generate a register of "sales" documents. Also, various reports will be implemented in the system, which will be similar in terms of the structure of creation.

Creation roles and appointment them users

Administration of the list of 1C:Enterprise users and assignment of roles to them in accordance with their official duties- very important points for organizing the interface of the applied solution as a whole and delimiting the rights and actions of its individual users.

Users should be restricted from performing actions on database objects. For example, the storekeeper can create Goods Receipt documents and record documents, since he is responsible for registering the receipt of goods. The manager, in turn, should have access to adding customer directories, drawing up a "sales" document, "reservation", but at the same time he should not have access to the receipt of goods.

Role configuration objects are used to describe such permissions. Each user of the system is assigned one or more roles.

Roles are created based on what permissions are required for different user groups to access information. The following roles will be implemented in our system:

• - administrator - in the 1C:Enterprise system there must be a role that includes full rights to work with IS data;
• - storekeeper;
• - manager;
• - IP.

Assignment of roles to users is carried out through the main menu item Administration -> Users.

Figure 3 - Creating an "Administrator" user with the "Administrator" role

Figure 4 - List of system users

The interactive delete right is disabled for all database objects for all roles.

Editing command interface sections and working table

Improving the application's command interface, setting the visibility of commands by roles and the desktop makes the application more user-friendly and gives it a complete look.

Let's sort the commands depending on the priority and frequency of use into the following groups:

• - navigation bar.Important;
• - navigation bar. Normal;
• - navigation bar. also;
• - action bar.Create and
• - action bar. Reports

Figure 5 - Command interface of the "Materials Accounting" section of a user with the "Storekeeper" role

Figure 6 - Command interface of the "Provision of Services" section of a user with the "Manager" role

Figure 7 - Command interface of the "Enterprise" section of a user with the "Director" role

Figure 8 - Command interface of the "Retail.Electronics" section of a user with the "Administrator" role

The desktop is designed to accommodate the most frequently used documents, reports, directories, etc. by the user. When 1C:Enterprise is launched, the Desktop section becomes active by default and the required forms immediately open in the application workspace.

Figure 9 - Desktop for a user with the role of "Storekeeper"

Figure 10 - Desktop for a user with the "Manager" role

automation wholesale software documentation

Ministry economic development and trade Russian Federation

APPROVE

State contract No. 000-05-07 dated October 29, 2007, concluded between the Ministry of Economic Development and Trade of the Russian Federation and CJSC PROGNOZ, for the execution of work on the topic “Development of an automated module for federal monitoring of socio-economic development of the constituent entities of the Russian Federation as part of the creation of a unified information system monitoring key indicators socio-economic development of the Russian Federation and monitoring the performance of the bodies state power to achieve them." When developing this document, the Guiding Document for Standardization GOST RD 50-34.698-90 was used. 1. General provisions.. 5 1.1. Full system name... 5 1.2. Documents on the basis of which the design is carried out.. 5 1.3. Stages and deadlines.. 5 1.4. Goals and purpose.. 7 1.5. Compliance of design solutions with safety requirements .. 8 1.6. Normative and technical documents... 9 2. Description of the process of activity.. 10 2.1. List of tasks.. 10 2.2. Main functions performed by the Module... 11 3. Main technical solutions.. 13 3.1. Structure of the Module, list of subsystems... 13 3.1.1. Subsystem of the Centralized data storage. fourteen 3.1.2. interface component. fifteen 3.1.3. Adapter software components. 16 3.6.3. The degree of adaptability to deviations of the parameters of the automation object. 26 3.6.4. Permissible limits of modernization and development of the system.. 26 3.6.5. reliability requirements. 27 3.6.6. Security requirement. 27 3.6.7. Requirements for ergonomics and technical aesthetics. 28 List of works Expected results of work Development of a Centralized Data Repository (CHD) of socio-economic information used in the implementation of federal monitoring of indicators of socio-economic development (PSED) of the constituent entities of the Russian Federation and municipalities Subsystem of the Centralized Data Storage Development of FSED data schemas and technology specification profiles that describe protocols for interaction with the interface component and formats for published FSEP data FSED data schemas and technology specification profiles that describe protocols for interaction with the interface component and formats for published FSEP data; A report on the discussion of draft specifications for data schemas and profiles of technological specifications, with recorded comments and suggestions from the participants in the discussion. Development, testing at pilot implementation sites and refinement, in accordance with the identified comments, of cross-platform software for the interface component Interface Components Mandatory adapter component Development of specific adapter components that provide automated acquisition of information about the SER from data sources inherited by the AIS and its publication through the interface component in accordance with its specifications. Specific adapters must contain a block for verifying and checking the validity of statistical information Specific adapter components; Regulations for the automatic collection of information used in the implementation of federal monitoring and supplied from websites and from the AIS of federal ministries and departments, constituent entities of the Russian Federation, municipalities in accordance with the developed specifications of the output parameters intended to provide information by these data sources Development of tabular, graphical, cartographic, textual presentation of the results of monitoring and analysis of the socio-economic development of the constituent entities of the Russian Federation. Subsystem for tabular, graphical, cartographic, textual presentation of monitoring data and analysis results of the socio-economic development of the constituent entities of the Russian Federation Development of a subsystem of the Module designed to calculate criteria for assessing the development of economic sectors of the subjects of the federation based on information collected in the process of federal monitoring Subsystem for calculating criteria for assessing the development of economic sectors of the subjects of the Russian Federation (with the possibility of identifying regional clusters) based on information collected in the process of federal monitoring Development of a subsystem of the Module designed to calculate integral indices and assessments of the socio-economic development of subjects of the federation based on information collected in the process of federal monitoring Subsystem for calculating integral indices and assessments of the socio-economic development of the constituent entities of the Russian Federation based on information collected in the process of federal monitoring Development of a subsystem of the Module designed to publish information about the SDS in accordance with the requirements of the current regulations and those developed within the project, as well as the specifications for the interface component The subsystem for publishing in the public domain the primary and converted information about the SER stored in the Module Development of the administration subsystem Administration Subsystem Full package of project documentation for the Federal Monitoring Module in accordance with the requirement of GOST 34 Carrying out acceptance tests, finalizing the Module in accordance with the Customer's comments

Explanatory note(PP) is one of the most important points of the Technical Design, which contains a complete description and characteristics of the selected technologies that determine the type and design of the system under study.

An explanatory note is necessary to reflect information about the object, the adopted technical solutions and their justification.

The composition of the explanatory note

The explanatory note to the draft of any OKS contains subsections:

1. Introduction. This section indicates the name of the object or system, the topic of development and the list of documents - the foundation for starting work. The main documentation given in the Introduction:
a document of a certain (federal, departmental, regional) level authorizing the development of the project; the decision of the relevant authorities; investor decision.

This section also includes:

design task (if the project is developed on the basis of a contract); documents establishing the ownership of the object capital construction(if project documentation is developed for the reconstruction or repair of the facility); reports on the results of engineering studies and tests; approved plan of the land plot allocated for development; documents for the use of land plots that do not fall under the influence of urban planning regulations received from authorized federal, executive or local authorities; technical specifications and documents allowing derogation from them; acts of the owner of the object on the necessary demolition of some structures from the construction site; permission to deviate from the boundary values ​​of capital construction projects.
2. Functionality, purpose of the object, further operation. This section describes the goals, objectives and scope of the developed object.
3. Specifications. This is the most voluminous section, consisting of interrelated subsections. This chapter includes:
data on the need to provide the facility with gas, water, fuel and electricity; information about the design capacity (for industrial facilities); information on the volumes of required raw materials, water, fuel and energy resources and data on their use (for production facilities); information about seized plots (for temporary or permanent use), justification of their size, if they are not regulated by the norms; in case of withdrawal of land for temporary or permanent use - data on the amount of material resources necessary to compensate for losses to their owners; characteristics of the category of land allocated for development; data on available special specifications(if necessary).
4. Technical and economic indicators - reflects information about the design capacity of the OKS, its significance for the population, the number of future employees, the number of jobs, etc.

Also at this stage, it is possible to characterize the computer programs used in the development of the project. Information is provided on the likely costs for the demolition of buildings and structures, the resettlement of people, the movement of communications, structures, etc. (if necessary). A description and justification of the possibility of implementing a staged construction of an object is carried out, the allocation of stages (if necessary).

The PP section must necessarily contain confirmation design organization that all documentation is developed and executed in accordance with the documents:

town-planning plan of the land plot; design assignments; urban planning regulations; others technical regulations and requirements.
5. Bibliography. This section contains sources, documents, articles, books, links to which were indicated in the text part of the project.

The explanatory note also contains textual information on the rationale for the adopted technological and technical solutions, indicators for the master plan, internal and external transport, etc.

The graphic part of the PP is represented by the corresponding drawings for a better perception of pre-written textual information. This subsection includes a general general plan of the area with transport communications and engineering networks, on which the projected object is superimposed; a detailed drawing of the design object itself (for production facilities, it is also necessary to apply technological processes); power supply, heat supply schemes, etc.

Our company will execute an explanatory note to the project for the construction, overhaul or reconstruction of a residential or production value according to established standards and requirements. Our assistance will help you with problems and delays in the coordination of the project in various instances and will ensure a quick obtaining of a building permit.

As a rule, the Explanatory Note is the most complex software document, sometimes causing a lot of controversy and discussion around its content. Why does this happen?

Appointment of an explanatory note

We have already talked about what is in development software is one of the important steps. It should contain a description of your system, taking into account the selected technologies, as required by GOST 34. And the document Explanatory note to technical project, or, for short, PP, is one of the main documents of this stage. And, I must say, most often it is the Explanatory Note that is the most complex document on software, sometimes causing a lot of controversy and discussion around its content.

Composition of a typical explanatory note

The explanatory note to the technical project includes such sections as:

– Introduction. This section contains the full name of the system and the topic of development, as well as a list of documents that served as the basis for the work on the project.

– Purpose and scope. It describes the goals and objectives that will be solved with the help of the system, as well as the scope of its use.

– Specifications. This section is usually divided into subsections, which describe: setting the task of creating a program; used mathematical apparatus; software operation algorithm; structure of input and output data; composition of hardware and software. It is also necessary to provide calculations and analysis results to justify the choice of exactly those decisions that are mentioned in the document.

– Expected technical and economic indicators. The section assumes an economic justification for the development, taking into account its technical indicators.

– Sources used in development. A section is a list of documents, articles and publications that have been referenced in the text.

Standards for explanatory note

The composition of the sections is determined by GOST 19.404, however, the standard allows these sections to be combined, if necessary, and also to add new ones. In the case of using GOST series 34, a document should be developed in accordance with RD 50-34.698. However, the document must remain within the requirements of general standards, such as, for example, GOST 19.105.

The cost of developing an explanatory note

How, then, at the lowest cost to create a document for the program, the most useful for your project, which:

- on the one hand, clearly and intelligibly presents all the necessary (and sometimes boring) information, including complex technical details;

An example of an "Explanatory note" (P2 on), developed for an automated measuring and information system for commercial electricity metering (AIIS KUE) in accordance with k, and document. by i. Edition dated 06/20/2018.

Explanatory note (P2 according to GOST 34.201-89) of the automated measuring and information system for commercial electricity metering (AIIS KUE) (example)

Created on 03/25/2014 11:48:18 AM

Attention! Technical requirements of the Wholesale Electricity Market (WEM), references to the points of which are contained in the examples of documents for automated measuring and information systems for commercial electricity metering (AIIS KUE), change quite often, but not by us, but by the administrator of the trading system (ATS). Please treat this with understanding.

All documents combat, which have passed many, including examinations at the Federal State Unitary Enterprise "All-Russian Research Institute for Standardization and Certification in Mechanical Engineering" (VNIIMASH) of ROSSTANDART, therefore there is no doubt.

For getting free an abbreviated version of any *.pdf is enough to click on the title page. The document will open in the browser with the option to. Full versions documents - paid, they can be obtained in the format for a certain amount, using. Any document can be finalized for specific customer requirements for some time. Terms are being discussed.