Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Описание запроса к системе
 
У меня тупик, поможите...
Как описать запрос к системе?
В систему поступает запрос (назовем его "Запрос на создание объекта" со стороны клиента через интеграционную платформу на выполнение каких-то действий. В результате обработки этих данных в системе создается какой-то объект.
Как это описать? Начал так:


Запрос на создание объекта это список требований к системе, в результате которого будет создан Объект.
Запрос может быть создан в ручном режиме или загружен в систему при помощи системы интеграции.

И вот тут я понимаю, что запрос это не список требований к системе, а нечто другое) а что?
Изменено: Ден - 25.09.2014 15:26:24
Торопливость в выводах может привести к неприятностям
 
Сообщение? Тип сообщения?
Изменено: techwriter - 25.09.2014 14:43:43
techwriter.ru.com
 
Цитата
Ден пишет:
тут я понимаю, что запрос это не список требований к системе, а нечто другое) а что?
Как правило, это структурированное сообщение, созданное согласно некоторому протоколу обмена данными.
 
Не совсем правильно объяснил... Это интеграционное решение, клиент кладет файл на FTP сервер, система его подхватывает, создает в системе документ и автоматически  заполняет его  данными.
Торопливость в выводах может привести к неприятностям
 
Цитата
Ден пишет:
файл на FTP сервер, система его подхватывает, создает в системе документ и автоматическизаполняет егоданными
Собственно, этот процесс и называется "запросом", как я поняла? :)
Тогда бы просто назвала это процессом автоматической загрузки данных из файлов, в результате которого регистрируются такие-то объекты. В систему загружаются файлы, выложенные клиентом на FTP-сервер. Только как-то покрасивее изложить :)))
techwriter.ru.com
 
Цитата
Ден пишет:
Как описать запрос к системе?
Для кого это пишется?

Цитата
techwriter пишет:
Цитата
Ден пишет:
файл на FTP сервер, система его подхватывает, создает в системе документ и автоматическизаполняет егоданными
Собственно, этот процесс и называется "запросом", как я поняла?  :)  
Тогда бы просто назвала это процессом автоматической загрузки данных из файлов, в результате которого регистрируются такие-то объекты. В систему загружаются файлы, выложенные клиентом на FTP-сервер. Только как-то покрасивее изложить  :)  ))
Собственно этот процесс легко может называться "вызовом хранимой процедуры". Скрипт, мониторящий FTP, при нахождении такового вызывает в системе хранимую процедуру, которая парсит файл и записывает найденные данные в БД. Затем эти данные подставляются в шаблон документа или форму в системе.
Изменено: ADVANCED - 25.09.2014 16:17:02
 
Цитата
ADVANCED пишет:
Цитата
Ден пишет:
Как описать запрос к системе?
Для кого это пишется?
Цитата
techwriter пишет:
Цитата
Ден пишет:
файл на FTP сервер, система его подхватывает, создает в системе документ и автоматическизаполняет егоданными
Собственно, этот процесс и называется "запросом", как я поняла?  :)  
Тогда бы просто назвала это процессом автоматической загрузки данных из файлов, в результате которого регистрируются такие-то объекты. В систему загружаются файлы, выложенные клиентом на FTP-сервер. Только как-то покрасивее изложить  :)  ))
Собственно этот процесс легко может называться "вызовом хранимой процедуры". Скрипт, мониторящий FTP, при нахождении такового вызывает в системе хранимую процедуру, которая парсит файл и записывает найденные данные в БД. Затем эти данные подставляются в шаблон документа или форму в системе.
Я думаю, описание для пользователей, нежели для админов.
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Цитата
Ден пишет:
Как описать запрос к системе?
Для кого это пишется?
Цитата
techwriter пишет:
Цитата
Ден пишет:
файл на FTP сервер, система его подхватывает, создает в системе документ и автоматическизаполняет егоданными
Собственно, этот процесс и называется "запросом", как я поняла?  :)  
Тогда бы просто назвала это процессом автоматической загрузки данных из файлов, в результате которого регистрируются такие-то объекты. В систему загружаются файлы, выложенные клиентом на FTP-сервер. Только как-то покрасивее изложить  :)  ))
Собственно этот процесс легко может называться "вызовом хранимой процедуры". Скрипт, мониторящий FTP, при нахождении такового вызывает в системе хранимую процедуру, которая парсит файл и записывает найденные данные в БД. Затем эти данные подставляются в шаблон документа или форму в системе.
Я думаю, описание для пользователей, нежели для админов.
Тогда резонный вопрос, зачем это нужно знать пользователям?
Если нужно объяснить процесс, то просто: "кладешь файл, система его распознает и преобразует в документ "такой-то". Выражения "загадочным образом" или "волшебным действием" не обязательно употреблять.  :)
Изменено: ADVANCED - 25.09.2014 16:36:25
 
Цитата
ADVANCED пишет:
Тогда резонный вопрос, зачем это нужно знать пользователям?
Если нужно объяснить процесс, то просто: "кладешь файл, система его распознает и преобразует в документ "такой-то". Выражения "загадочным образом" или "волшебным действием" не обязательно употреблять.  :)  
В системе есть понятие "Запрос", как я понимаю. Ему надо дать определение. Вот Ден его и даёт  :) ))
Изменено: techwriter - 25.09.2014 16:40:23
techwriter.ru.com
 
Тут ситуация такая, можно создать через FTP система сама все сделает, но есть и возможность добавить вручную , вот тут и трудность. Да у меня трудность с определением этого запроса т.е я пытаюсь сказать, что это вообще такое, а у меня ничего не получается   :cry:

все это для пользователей делаю, все ради них!
Изменено: Ден - 25.09.2014 17:15:40
Торопливость в выводах может привести к неприятностям
 
Цитата
Ден пишет:
Да у меня трудность с определением этого запроса т.е я пытаюсь сказать, что это вообще такое, а у меня ничего не получается
Запрос к системе — это структурированное сообщение, созданное согласно некоторому протоколу обмена данными, при получении которого система должна выполнить некоторое заданное действие.

Если формат (протокол) запроса уже описан, надо сослаться на описание.

Если не описан, то надо его описать. Например, так как здесь или здесь.
В дальнейшем при описании запросов указывается назначение запроса, его параметры и получаемые результаты.  
Страницы: 1
Читают тему