Software Requirements Specifications Document Требования к проекту «Falcon Manager» (система покупки авиабилетов) Версия: (1) D:\681447699.doc Дата: (03/01/2008) Page 1 of 18 04/27/16 f Software Requirements Specifications Document Содержание 1. Введение 4 1.1 Назначение 4 1.2 Область действия 4 1.3 Список определений, сокращений и аббревиатур 5 1.4 Ссылки 5 1.5 Структура документа 5 2. Общее описание 5 2.1 Перспективы продукта 2.1.1 Системные интерфейсы 2.1.2 Интерфейс 2.1.3 Аппаратные интерфейсы 2.1.4 Программные интерфейсы 2.1.5 Интерфейсы коммуникации 2.1.6 Ограничения по памяти 2.1.7 Операции по восстановлению данных 2.1.8 Условия работы системы 5 5 6 6 6 6 7 7 7 2.2 Функции продукта 2.2.1. Хранение информации об авиарейсах и ценах на билеты 2.2.2. Обновление и коррекция информации в базе данных 2.2.3. Покупка билетов 2.2.4. Отображение обновленного состояния базы данных 7 7 7 8 8 2.3 Характеристика пользователей 8 2.4 Ограничения 2.4.1. Использование языка Java при создании клиент-приложения 2.4.2. Параллельная обработка запросов, поступающих от клиентов, в серверном приложении 8 8 8 2.5 Предположения и зависимости 8 2.6 Приоритеты требований 9 3. Специфические требования 9 3.1 Сущности, с которыми работает система 9 3.2 Функции 3.2.1 Функции клиента Monitor 3.2.2 Функции клиента Editor 3.2.3 Функции сервера 10 10 11 11 3.3 Требования по производительности 12 3.4 Logical Database Requirements 12 3.5 Design Constraints 3.5.1 Standards Compliance 12 12 D:\681447699.doc Page 2 of 18 04/27/16 f Software Requirements Specifications Document 3.6 Software System Attributes 3.6.1 Reliability 3.6.2 Availability 3.6.3 Security 3.6.4 Maintainability 3.6.5 Portability 13 13 13 13 14 14 3.7 Organizing the Specific Requirements 3.7.1 System Mode 3.7.2 User Class 3.7.3 Objects 3.7.4 Feature 3.7.5 Stimulus 3. 7.6 Response 3.7.7 Functional Hierarchy 15 15 16 16 16 16 16 16 3.8 Additional Comments 16 4. Change Management Process 17 5. Document Approvals 17 6. Supporting Information 17 D:\681447699.doc Page 3 of 18 04/27/16 f Software Requirements Specifications Document 1. Введение В настоящем разделе описывается назначение, область действия и структура документа. Приводится список определений, сокращений и аббревиатур и список ссылок. 1.1 Назначение Настоящий документ описывает требования к системе бронирования авиабилетов Falcon Manager, разрабатываемой (вымышленной) фирмой Paraschenko & Tsarev в рамках курса «Архитектура и разработка распределенного программного обеспечения» по заказу (вымышленной) авиакомпании Falcon Airlines SPb. Настоящий документ предназначен для сотрудников Falcon Airlines SPb и Paraschenko & Tsarev, участвующих в разработке указанной системы. 1.2 Область действия Система бронирования авиабилетов Falcon Manager должна представлять собой распределенную систему, обеспечивающую бронирование билетов на самолеты различных авиакомпаний. Задачами системы являются: 1. Поддержка возможностей обновления и коррекции информации в БД (внесение новых рейсов, изменение цен, и.т.п.). 2. Осуществление постоянного мониторинга состояния базы клиентами. После загрузки клиент должен отображать состояние базы в своем окне и обновлять его по мере необходимости (при изменении количества свободных билетов, вследствие бронирования, произведенного другими клиентами или при иных модификациях данных). 3. Поддержка возможности продажи билетов специально обученным оператором. При этом система не должна обладать возможностями составления какихлибо маршрутов, состоящих более чем из одного авиаперелета, и вычисления их стоимости. Система Falcon Manager будет применяться для упрощения процесса бронирования и покупки билетов авиакомпании Falcon Airlines SPb. Переход от ручного вненесения изменений в базу данных к применению разрабатываемой системы позволит ускорить процесс покупки билетов в несколько раз, а также на порядок снизить количество ошибок, допускаемых кассирами. D:\681447699.doc Page 4 of 18 04/27/16 f Software Requirements Specifications Document 1.3 Список определений, сокращений и аббревиатур CORBA – Common Object Request Broker Architecture, общая архитектура брокера объектных запросов OMG – Object Management Group 1.4 Ссылки 1. OMG’s CORBA web site. http://www.corba.org/ 1.5 Структура документа Глава 2 содержит описание системы Falcon Manager общими словами без деталей. Она предназначена для ознакомления с проектируемой системой. В главе 3 содержится детализированное описание функциональности Falcon Manager. 2. Общее описание 2.1 Перспективы продукта Разрабатываемый программный продукт не является частью более крупной программной системы. Система Falcon Manager должна содержать серверную часть и клиентскую часть. При этом необходимо разработать два типа клиентов – для бронирования билетов и для изменения информации, хранящейся в базе данных. Ближайшими аналогами разрабатываемой системы являются системы поиска и бронирования билетов, используемые авиакомпаниями Air France (www.airfrance.com), Lufthansa (www.lufthansa.com), British Airways (www.britishairways.com) и другими, а также online системы бронирования билетов Expedia (www.expedia.com) и Yahoo! Travel (travel.yahoo.com). Основным отличием от указанных систем является большая простота использования (которая достигается за счет уменьшения функциональности, не включающей поиск маршрутов перелетов). Таким образом, разрабатываемая система строится по принципу «ничего лишнего», при этом реализуется только базовая (но при этом наиболее востребованная пользователем) функциональность системы бронирования и покупки авиабилетов. За счет этого достигается гораздо меньшая стоимость разработки. 2.1.1 Системные интерфейсы При использовании системы оператор загружает апплет Monitor с удаленного сервера с помощью браузера. D:\681447699.doc Page 5 of 18 04/27/16 f Software Requirements Specifications Document 2.1.2 Интерфейс Серверная часть системы не имеет графического интерфейса, работает в консольном режиме. Клиентская часть системы должна иметь графический интерфейс. Необходимо разработать два вида клиентов: 1. Клиент Monitor. Его задачами будут реализация GUI, выполнение пользовательских запросов по бронированию и отображение текущего состояния базы данных. Все изменения базы данных должны немедленно отображаться во всех клиентах такого типа, что позволит пользователю всегда иметь актуальную информацию о доступных билетах. 2. Клиент Editor, в задачи которого входит внесение изменений в базу данных по запросу пользователя. Все изменения базы данных должны немедленно отображаться во всех клиентах такого типа, что позволит пользователю всегда иметь актуальную информацию. 2.1.3 Аппаратные интерфейсы У системы нет никаких требований к аппаратным интерфейсам, так как она не взаимодействует напрямую ни с каким аппартным обеспечением. 2.1.4 Программные интерфейсы В настоящем разделе описаны программные интерфейсы, которые должна использовать разрабатываемая система. 2.1.4.1 Oracle 10g Разрабатываемая система должна использовать Oracle 10g в качестве сервера баз данных. Для развертывания системы вместе с ней должны поставляться SQL-скрипты, создающие необходимые таблицы базы данных. С базой данных должна взаимодействовать только серверная часть системы. 2.1.5 Интерфейсы коммуникации Взаимодействие между клиентом Monitor и сервером должно осуществляться с использованием технологии CORBA (http://www.corba.org/). 2.1.5.1. CORBA Клиент должен быть одновременно CORBA-клиентом, осуществляющим вызовы методов сервера (другого приложения, служащего прослойкой между D:\681447699.doc Page 6 of 18 04/27/16 f Software Requirements Specifications Document клиентом и БД) и CORBA-сервером, чьи методы будут вызываться сервером в случае изменений в БД. 2.1.6 Ограничения по памяти Часть системы, требующая наибольшее количество памяти – это база данных (ее разрабатывать не надо, так как используется СУБД Oracle10g). Для серверной части системы ограничения по памяти могут возникнуть, если она запускается на одном компьютере с СУБД. Такой вариант использования системы вполне вероятен, поэтому память, задействованная сервером не должна превышать 128-256 Мб. Клиентские приложения должны использовать не более 64 мегабайт оперативной памяти. Это ограничение вызвано особенностями апплетов, написанных на языке программирования Java. 2.1.7 Операции по восстановлению данных Все данные, генерируемые и используемые системой, хранятся в базе данных. Для того, чтобы сохранить резервную копию данных, можно воспользоваться средствами Oracle (http://www.oracle.com/technology/obe/2day_dba/backup/backup.htm#t2). 2.1.8 Условия работы системы Перед установкой системы «Falcon Manager» необходимы следующие приготовления – на компьютер с сервером должна быть установлена СУБД Oracle10g; сервер должен быть доступен в глобальной сети и на нем должен работать Web-сервис, необходимый для загрузки с него апплета (также должен быть открыт 80 порт). Перед установкой системы необходимо создать на сервере баз данных таблицы для хранения данных об авиарейсах. 2.2 Функции продукта Приведем список основных функций разрабатываемой системы. 2.2.1. Хранение информации об авиарейсах и ценах на билеты Должна быть создана база данных, хранящая иноформацию об авиарейсах и доступных билетах. 2.2.2. Обновление и коррекция информации в базе данных Администратор системы должен иметь возможность с помощью специального приложения (апплет Monitor) корректировать имеющуюся и добавлять новую информацию в базу данных: D:\681447699.doc Page 7 of 18 04/27/16 f Software Requirements Specifications Document добавлять новый рейс; изменять стоимость билета на существующий рейс; аннулировать купленные ранее билеты. 2.2.3. Покупка билетов Операторы системы должны иметь возможность с помощью компьютера, подключенного к глобальной сети Интернет, осуществлять продажу билетов клиентам авиакомпании. Для оператор узнает у клиента авиакомпании, откуда и куда тот собирается ле 2.2.4. Отображение обновленного состояния базы данных Клиентская программа должна отображать обновленное состояние базы (при изменении количества свободных билетов, вследствие бронирования, произведенного другими клиентами, или при модификации базы). 2.3 Характеристика пользователей Предполагаются, что разрабатываемой системой будут пользоваться две категории пользователей. администратор – обладает опытом работы с системами, использующими базы данных; оператор – специально обучен для работы с апплетом Monitor. 2.4 Ограничения Ниже перечислены ограничения на технологии, используемые при разработке системы. 2.4.1. Использование языка Java при создании клиент-приложения Данное ограничение вызвано требованием работоспособности клиента в любом браузере, поддерживающем апплеты, в любой операционной системе. 2.4.2. Параллельная обработка запросов, поступающих от клиентов, в серверном приложении Данное ограничение вызвано необходимостью быстрой обработки запросов сервером и низкого времени отклика. 2.5 Предположения и зависимости Аналогичные по назначению системы существуют на рынке в большом количестве. Многие авиакомпании используют аналогичные программные D:\681447699.doc Page 8 of 18 04/27/16 f Software Requirements Specifications Document продукты. Реальные системы разрабатываются индивидуально, с учетом всех требований конкретного заказчика. Falcon Manager, напротив, представляет собой экспериментальную систему, не предназначенную для повседневного использования. Данный документ полагается на то, что разрабатываемая система является образовательным проектом с целью обучить вовлеченных людей ряду технологий. Предполагается, что система не будет использоваться на практике. Проектируемая система содержит основную часть внешней функциональности реальных систем покупки авиабилетов. В то же время она имеет множество ограничений: не обеспечивается высокая безопасность передаваемой информации; не обеспечивается устойчивость к аппаратным сбоям, к программным атакам на сервера и прочим опасностям, которым подвержены реальные системы; не обеспечивается высокая вероятность работы системы без сбоев; не обеспечивается возможность плавного перехода с одной версии ПО на другую, без приостановки обслуживания клиентов. В частности по этим причинам система имеет низкую стоимость разработки. 2.6 Приоритеты требований Некоторые требования имеют более высокий приоритет и должны быть выполнены первыми. В разрабатываемом продукте обязательно должна присутствовать клиентсерверная система, позволяющая оператору системы покупать билеты. Менее важным является наличие системы модификации базы данных для администратора системы. Вместо этого на первом этапе могут быть написаны вспомогательные утилиты, выполняющие заполнение базы данных для тестирования. 3. Специфические требования В настоящей главе изложены подробные требования к функциональности продукта. 3.1 Сущности, с которыми работает система Система работает со следующими сущностями: аэропорт (характеризуется названием и кодом); самолет (характеризуется названием); место в самолете (характеризуется кодом и самолетом); D:\681447699.doc Page 9 of 18 04/27/16 f Software Requirements Specifications Document рейс (характеризуется аэропортами отправления и прибытия, временами отправления и прибытия и самолетом, на котором осуществляется рейс); билет (характеризуется рейсом, местом и данными покупателя). Эти сущности и связи между ними показаны на рис. 1. Самолет 1 Название 1 * Рейс Аэропорт 1 2 Аэропорт отправления Аэропорт прибытия Время отправления Время прибытия Самолет Полное имя Код 1 * Место * 1 Билет * Код Самолет Рейс Место ФИО покупателя Паспортные данные Рис. 1. Основные сущности системы 3.2 Функции В настоящем разделе описаны функции различных компонентов системы. 3.2.1 Функции клиента Monitor Должна быть возможность предоставлять пользователю список всех рейсов, летящих из пункта A в пункт B в определенный интервал времени, а также информацию о количестве свободных мест на каждом из этих рейсов. D:\681447699.doc Page 10 of 18 04/27/16 f Software Requirements Specifications Document Должна быть возможность купить билет на указанный рейс. При этом, желательно, чтобы пользователь имел возможность выбрать устраивающее его место из списка непроданных мест. Не должна возникать ситуация, когда два или более пользователя купили билет на одно и то же место некоторого рейса. В случае попытки пользователя купить уже проданный билет, должно выводиться соответствующее сообщение. 3.2.2 Функции клиента Editor Должна быть возможность добавлять в систему информацию о новом рейсе. Должна быть возможность менять дату/время отправления и прибытия рейса. При этом, дата/время прибытия должна быть позже даты/времени отправления. Нельзя менять дату/время отправления на прошлое. 3.2.3 Функции сервера Сервер должен предоставлять клиентам достаточно информации, чтобы последние имели возможность функционировать в соответствии с требованиями, указанными в пунктах 3.2.1 и 3.2.2. Сервер должен оповещать клиентов обо всех изменениях в базе данных, связанных с информацией, отображаемой на клиенте. Таким образом, должна достигаться актуальность всей отображаемой клиентами информации. Functional requirements define the fundamental actions that must take place in the software in accepting and processing the inputs and in processing and generating the outputs. These are generally listed as “shall” statements starting with "The system shall… These include: Validity checks on the inputs Exact sequence of operations Responses to abnormal situation, including Overflow Communication facilities Error handling and recovery Effect of parameters Relationship of outputs to inputs, including Input/Output sequences Formulas for input to output conversion D:\681447699.doc Page 11 of 18 04/27/16 f Software Requirements Specifications Document It may be appropriate to partition the functional requirements into sub-functions or sub-processes. This does not imply that the software design will also be partitioned that way. 3.3 Требования по производительности Учитывая современные запросы авиакомпаний, сервер должен уметь быстро отвечать на 10-20 запросов в секунду, и поддерживать 50-100 активных подключений. После того, как написана программа, максимальное количество клиентов, которые одновременно могут посылать запрос на сервер (т.е. активных клиентов) зависит от аппаратного обеспечения сервера, на котором запущена база данных. Здесь уместно говорить скорее не о максимальном количестве клиентов, а о времени отклика сервера при данном количестве клиентов (впрочем, после некоторого порогового значения количества клиентов очередь на сервере начнет неограниченно расти, и сервер «упадет»). Эти величины можно получить или опытным путем (используя специальную программу, моделирующую подключение и деятельность большого количества клиентов), или теоретическим – также используя программу для моделирования сети массового обслуживания. 3.4 Logical Database Requirements This section specifies the logical requirements for any information that is to be placed into a database. This may include: Types of information used by various functions Frequency of use Accessing capabilities Data entities and their relationships Integrity constraints Data retention requirements If the customer provided you with data models, those can be presented here. ER diagrams (or static class diagrams) can be useful here to show complex data relationships. Remember a diagram is worth a thousand words of confusing text. 3.5 Design Constraints Specify design constraints that can be imposed by other standards, hardware limitations, etc. 3.5.1 Standards Compliance D:\681447699.doc Page 12 of 18 04/27/16 f Software Requirements Specifications Document Specify the requirements derived from existing standards or regulations. They might include: (1) Report format (2) Data naming (3) Accounting procedures (4) Audit Tracing For example, this could specify the requirement for software to trace processing activity. Such traces are needed for some applications to meet minimum regulatory or financial standards. An audit trace requirement may, for example, state that all changes to a payroll database must be recorded in a trace file with before and after values. 3.6 Software System Attributes There are a number of attributes of software that can serve as requirements. It is important that required attributes by specified so that their achievement can be objectively verified. The following items provide a partial list of examples. These are also known as non-functional requirements or quality attributes. These are characteristics the system must possess, but that pervade (or cross-cut) the design. These requirements have to be testable just like the functional requirements. Its easy to start philosophizing here, but keep it specific. 3.6.1 Reliability Specify the factors required to establish the required reliability of the software system at time of delivery. If you have MTBF requirements, express them here. This doesn’t refer to just having a program that does not crash. This has a specific engineering meaning. 3.6.2 Availability Specify the factors required to guarantee a defined availability level for the entire system such as checkpoint, recovery, and restart. This is somewhat related to reliability. Some systems run only infrequently on-demand (like MS Word). Some systems have to run 24/7 (like an e-commerce web site). The required availability will greatly impact the design. What are the requirements for system recovery from a failure? “The system shall allow users to restart the application after failure with the loss of at most 12 characters of input”. 3.6.3 Security D:\681447699.doc Page 13 of 18 04/27/16 f Software Requirements Specifications Document Specify the factors that would protect the software from accidental or malicious access, use, modification, destruction, or disclosure. Specific requirements in this area could include the need to: Utilize certain cryptographic techniques Keep specific log or history data sets Assign certain functions to different modules Restrict communications between some areas of the program Check data integrity for critical variables 3.6.4 Maintainability Specify attributes of software that relate to the ease of maintenance of the software itself. There may be some requirement for certain modularity, interfaces, complexity, etc. Requirements should not be placed here just because they are thought to be good design practices. If someone else will maintain the system 3.6.5 Portability Specify attributes of software that relate to the ease of porting the software to other host machines and/or operating systems. This may include: Percentage of components with host-dependent code Percentage of code that is host dependent Use of a proven portable language Use of a particular compiler or language subset Use of a particular operating system Once the relevant characteristics are selected, a subsection should be written for each, explaining the rationale for including this characteristic and how it will be tested and measured. A chart like this might be used to identify the key characteristics (rating them High or Medium), then identifying which are preferred when trading off design or implementation decisions (with the ID of the preferred one indicated in the chart to the right). The chart below is optional (it can be confusing) and is for demonstrating tradeoff analysis between different non-functional requirements. H/M/L is the relative priority of that non-functional requirement. Characteristic I D H 1 /M/L 1 2 3 4 urity 2 3 4 5 6 7 8 9 1 1 0 1 2 Correctness Efficiency Flexibility Integrity/Sec D:\681447699.doc Page 14 of 18 04/27/16 f 1 Software Requirements Specifications Document 5 ity 6 ity 7 8 9 1 Interoperabil Maintainabil Portability Reliability Reusability Testability 0 1 Usability 1 Availability 1 2 Definitions of the quality characteristics not defined in the paragraphs above follow. • Correctness - extent to which program satisfies specifications, fulfills user’s mission objectives • Efficiency - amount of computing resources and code required to perform function • Flexibility - effort needed to modify operational program • Interoperability - effort needed to couple one system with another • Reliability - extent to which program performs with required precision • Reusability - extent to which it can be reused in another application • Testability - effort needed to test to ensure performs as intended • Usability - effort required to learn, operate, prepare input, and interpret output THE FOLLOWING (3.7) is not really a section, it is talking about how to organize requirements you write in section 3.2. At the end of this template there are a bunch of alternative organizations for section 3.2. Choose the ONE best for the system you are writing the requirements for. 3.7 Organizing the Specific Requirements For anything but trivial systems the detailed requirements tend to be extensive. For this reason, it is recommended that careful consideration be given to organizing these in a manner optimal for understanding. There is no one optimal organization for all systems. Different classes of systems lend themselves to different organizations of requirements in section 3. Some of these organizations are described in the following subclasses. 3.7.1 System Mode D:\681447699.doc Page 15 of 18 04/27/16 f Software Requirements Specifications Document Some systems behave quite differently depending on the mode of operation. When organizing by mode there are two possible outlines. The choice depends on whether interfaces and performance are dependent on mode. 3.7.2 User Class Some systems provide different sets of functions to different classes of users. 3.7.3 Objects Objects are real-world entities that have a counterpart within the system. Associated with each object is a set of attributes and functions. These functions are also called services, methods, or processes. Note that sets of objects may share attributes and services. These are grouped together as classes. 3.7.4 Feature A feature is an externally desired service by the system that may require a sequence of inputs to effect the desired result. Each feature is generally described in as sequence eof stimulus-response pairs. 3.7.5 Stimulus Some systems can be best organized by describing their functions in terms of stimuli. 3. 7.6 Response Some systems can be best organized by describing their functions in support of the generation of a response. 3.7.7 Functional Hierarchy When none of he above organizational schemes prove helpful, the overall functionality can be organized into a hierarchy of functions organized by either common inputs, common outputs, or common internal data access. Data flow diagrams and data dictionaries can be use dot show the relationships between and among the functions and data. 3.8 Additional Comments D:\681447699.doc Page 16 of 18 04/27/16 f Software Requirements Specifications Document Whenever a new SRS is contemplated, more than one of the organizational techniques given in 3.7 may be appropriate. In such cases, organize the specific requirements for multiple hierarchies tailored to the specific needs of the system under specification. Three are many notations, methods, and automated support tools available to aid in the documentation of requirements. For the most part, their usefulness is a function of organization. For example, when organizing by mode, finite state machines or state charts may prove helpful; when organizing by object, object-oriented analysis may prove helpful; when organizing by feature, stimulus-response sequences may prove helpful; when organizing by functional hierarchy, data flow diagrams and data dictionaries may prove helpful. In any of the outlines below, those sections called “Functional Requirement i” may be described in native language, in pseudocode, in a system definition language, or in four subsections titled: Introduction, Inputs, Processing, Outputs. 4. Change Management Process Identify the change management process to be used to identify, log, evaluate, and update the SRS to reflect changes in project scope and requirements. How are you going to control changes to the requirements. Can the customer just call up and ask for something new? Does your team have to reach consensus? How do changes to requirements get submitted to the team? Formally in writing, email or phone call? 5. Document Approvals Identify the approvers of the SRS document. Approver name, signature, and date should be used. 6. Supporting Information The supporting information makes the SRS easier to use. It includes: Table of Contents Index Appendices The Appendices are not always considered part of the actual requirements specification and are not always necessary. They may include: D:\681447699.doc Page 17 of 18 04/27/16 f Software Requirements Specifications Document (a) Sample I/O formats, descriptions of cost analysis studies, results of user surveys (b) Supporting or background information that can help the readers of the SRS (c) A description of the problems to be solved by the software (d) Special packaging instructions for the code and the media to meet security, export, initial loading, or other requirements When Appendices are included, the SRS should explicitly state whether or not the Appendices are to be considered part of the requirements. Tables on the following pages provide alternate ways to structure section 3 on the specific requirements. You should pick the best one of these to organize section 3 requirements. D:\681447699.doc Page 18 of 18 04/27/16 f