kopnik.org

ТЕХНИЧЕСКОЕ ЗАДАНИЕ

 

на разработку системы

«Электронное копное право »

 

СПИСОК ТЕРМИНОВ И СОКРАЩЕНИЙ

Термин (сокращение)	Определение
Копа	Собрание копных мужей с целью принятия коллективных решений
Копный муж (Копник)	Пользователь Системы, который прошел процедуру заверения
Мессенджер	ВКонтакте
Ранг копника (десятник, сотник, ...)	Количество Копников в дружине данного копника
Ранг копы	Сумма рангов Копников, присутствующих на Копе
Система	Электронное копное право kopnik.org
Старшина	Роль, на которую Копники выдвигают одного из своего круга, для того чтобы он говорил от их имени на копах более высокого ранга.
ТЗ	Техническое задание

 

НАЗНАЧЕНИЕ, ЦЕЛИ И РЕЗУЛЬТАТЫ СОЗДАНИЯ СИСТЕМЫ

Назначение системы

• Регистрация копных мужей по всему миру в одном месте.
• Поиск копных мужей.
• Созыв копных мужей на копу.
• Обсуждение и принятие решений на копе.
• Общение со своей десяткой и десяткой Старшины.

Цели создания Системы

• Объединение славянских родов в 300 миллионную человеческую машину.
• Выдвижение легитимных представителей для общения с властью и межнационального диалога.
• Повышение уровня безопасности.
• Повышение нравственности.
• Развитие на принципах самоуправления.
• Сокращение коррупции в 100 раз.
• Повышение уровня благосостояния в 2 раза.

Результаты создания Системы

• Система согласно данного ТЗ, размещенная и функционирующая на серверах.
• Автоматизированные тесты, в том числе по установке и настройке операционной системы и компонентов системы, сервера приложений,  клиентской стороны.
• Руководство пользователя.
• Руководство администратора
• Исходные коды на GitHub под свободной лицензией.

ХАРАКТЕРИСТИКА ОБЪЕКТА АВТОМАТИЗАЦИИ

Объектом автоматизации является “человеческая машина”, построенная на принципах копного права. Размер такой человеческой машины колеблется от 2 человек до 300 миллионов человек. Люди, входящие в такую “человеческую машину” могут проживать в разных странах, говорить на разных языках.

МЕСТО ВЫПОЛНЕНИЯ РАБОТ

Исполнитель выполняет работы на:

• Собственных рабочих местах.
• Удаленных серверах Системы.
• GitHub.

ТРЕБОВАНИЯ К СИСТЕМЕ

Функциональные требования

Общие положения

Система должна автоматизировать процессы чистого копного права. Система не должна автоматизировать ничего, что не входит в чистое копное право.

Процессы чистого копного права

• Получение статуса копного мужа.
• Поиск других копных мужей.
• Созыв копных мужей на копу.
• Обсуждение вопросов и принятие решений на копе.
• Выбор старшины.
• Общение со своей десяткой и общение с десяткой старшины.

Гостевой режим

Для незарегистрированных пользователей Система должна предлагать упрощенный гостевой режим, включающий просмотр карты местности и зарегистрированных в Системе Копников. Остальные возможности Системы в гостевом режиме не доступны.

Получение статуса копного мужа

Система должна позволять регистрироваться пользователям в Системе. Регистрация происходит через аккаунт ВКонтакте. На этапе регистрации Система должна получать ФИО, возраст и местоположение пользователя и последние четыре цифры паспорта. Местоположение определяется с помощью автоматической геолокации или если она не доступна, самим пользователем в ручном режиме.

После прохождения регистрации Система должена сформировать неподтвержденный аккаунт. Сразу после этого Система должна создать в Мессенджере специальный чат для подтверждения аккаунта, добавить в него нового пользователя и Копника, который уже зарегистрирован в Системе с правами подтверждения аккаунта (Заверителя). Новый пользователь должен связаться со своим Заверителем и ответить на все его вопросы.

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

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

Поиск других копных мужей

Система должна отображать копников на карте. Если количество копников больше N (примерно 20 на экран телефона), то отображать первые N самых ранговых. Копники, чей старшина также отображен на карте, должны отображаться альтернативным цветом. Должна быть кнопка «Мое местоположение», которая перемещает окно просмотра карты на текущее местоположение Пользователя. Система должна позволять масштабировать и перемещать окно просмотра карты. Карта должна переключаться между режимами “схема” и “спутник”. Система должна запоминать текущий вид и положение карты и при повторном открытии восстанавливать его.

В системе должен быть доступен поиск Копника по ФИО. После набора первых букв должен выпадать список Копников, по которым найдено совпадение. Рядом с каждым Копником должно быть указано расстояние до него от центра окна просмотра карты. Элементы списка должны быть отсортированы по расстоянию. При выборе элемента списка окно карты должно смещаться к выбранному Копнику, его маркер на карте должен становиться активным и приобретать соответствующий цвет.

По клику на значке копника Система должна открывать карточку Копника с ФИО, годом рождения, Рангом.

По двойному клику на значок Копника на карте Система должна прорисовывать на карте дружину Копника. Дружина отображается значками копников из дружины, которые связываются прямыми линиями толщиной тем больше, чем больше ранг Дружинника. Если дружина очень большая, система должна ограничиться отображением N (примерно 20) наиболее ранговых Копников. Альтернативным цветом должны быть прорисованы связи Копника в сторону Старшин. Повторный двойной клик на карте скрывает дружину, возвращая карту в исходное состояние.

Созыв копных мужей на копу

Система должна позволять набирать Копников для предстоящей копы. Набор должен происходить кнопкой «Позвать на копу» на карточке Копника. Приглашенные копники отображаются в специальном списке длинной 10 элементов. После добавления в список первого приглашенного должна появляться кнопка «Созвать копу».

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

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

Выбор старшины

Система должна позволять выбрать / отменять выбор Старшину из карточки Копника посредством кнопки «Выбрать старшиной». После нажатия на кнопку система должна создать заявку на вступление в десятку Старшины и посылать Старшине PUSH-уведомление.

Система должна представлять Старшине список его десятки в виде списка из 10 ячеек. Ячейки должны быть заполнены теекущими Копниками из Малой дружины. Если их меньше 10, остальные ячейки должны отображаться пустыми. Система должна позволять добавлять Копников, подавших заявку, в Малую дружину, если там есть свободные ячейки, и удалять Копников из Малой дружины.

Общение со своей десяткой и десяткой Старшины

Система должна иметь быстрые кнопки для мгновенного перехода в групповой чат Мессенджера со своей десяткой и в групповой чат Мессенджера с десяткой Старшины.

Требования к Мессенджеру

Требования приведены в порядке важности:

1. Авторизация в сторонней системе через аккаунт Мессенджера
2. Открытое API Мессенджера, позволяющее создавать групповой чат, добавлять в групповой чат участников, добавлять в групповой чат сообщения.
3. Использование Мессенджера без афиширования номера мобильного телефона.
4. Создания открытого голосования внутри группового чата.
5. Пересылки завершенного голосования в другой чат, в том числе текста голосования, результата голосования, списка проголосовавших.
6. Доступность Мессенджера в приоритетных странах (Россия, Украина, Беларусь, страны Восточной Европы).
7. Популярность Мессенджера в приоритетных странах.
8. Аудио конференции в групповом чате.
9. Видео конференции в групповом чате.
10. Ожидаемая лояльность руководства Мессенджера к электронному копному праву.

 Требования к локализации

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

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

Требования к надежности

Система должна делать ежедневную резервную копию всей базы данных. Место хранения резервных копий согласовывается с Заказчиком на этапе разработки. Система должна хранить копию месячной давности и все дневные копии за последнюю неделю.

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

Требования по доступности

В случае плановой или аварийной смены сервера время для развертывания и запуска Системы на новом предоставленном сервере не должно превышать 24 часов.

Системные требования

ОС Ubuntu server последней LTS на дату заключения договора.

Vagrant

Операционная система и настройка компонентов Системы должна проходить через Vagrant на виртуальной машине  арендованного хостинга и виртуальной машине VirtualBox.

 

 

Postgres

• https://docs.docker.com/engine/examples/postgresql_service/
• https://GitHub.com/docker-library/docs/tree/master/postgres
• Последняя LTS
• Стандартный порт торчит из контейнера и виден в контейнере сервера приложений kopnik.org
• max_connections = 1000
• shared_buffers = 512MB
• effective_cache_size = 1024MB
• work_mem = 40MB

Почтовый сервер

• Входящие порты закрыты, сервер только отправляет сообщения
• Стандартный порт для отправки торчит из контейнера и виден в контейнере сервера приложений Системы

сервер приложений Системы

• https://nodejs.org/en/docs/guides/nodejs-docker-webapp/
• https://GitHub.com/nodejs/docker-node/blob/master/docs/BestP...
• Исходный код https://GitHub.com/kopnik-org/server
• установить в папку /home/ubuntu/sftp/server и подключить внутрь контейнера через volume
• Установить зависимости (команда npm install из папки с кодом)
• Внутри контейнера доступны порты для отправки почты 25, стандартный порт Postgres
• Команда для запуска сервера npm run server:production

nginx

• https://docs.docker.com/samples/library/nginx/
• Принимает входящие по 80 и 443
• Плагин для HTTP 2.0
• Два маршрута /api и по умолчанию
• маршрут /api перенаправляет весь трафик на порт 80 контейнера сервера приложений Системы
• маршрут по умолчанию отдает статические файлы из папки /home/ubuntu/sftp/client/dist (согласовывается с Заказчиком на этапе разработки)
• Сертификаты letsencrypt, которые хранятся на хосте, подключены внутрь контейнера через volume

Общие требования к исходному коду

Исходные коды должны быть оформлены и самозадокументированы в соответствии с общепринятыми правилами

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

Общие требования к возможности тестирования

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

Требования к серверу приложений

Серверная часть должна быть написана на платформе NodeJS или PHP.

Требования к клиентскому приложению

Клиентская часть должна быть написана на ВЕБ. Пользовательский интерфейс должен одинаково хорошо отображаться на устройствах с разным размером экрана.

Требования к масштабируемости

Система должна позволять общее количество пользователей 35 млн и одновременную работу 5 млн пользователей. Количество одновременных пользователей на одну Docker-ноду сервера приложений 1 тыс.

СОСТАВ, СРОКИ И СОДЕРЖАНИЕ РАБОТ ПО СОЗДАНИЮ СИСТЕМЫ

Общая длительность работ не должна превышать 5 месяцев с даты заключения договора.

 

 

 

 

Состав работ	Результат	Длительность
Разработка системы	Система согласно данного ТЗ, размещенная и функционирующая на серверах (BETA). Автоматизированные тесты системной части, клиентской стороны и серверной стороны. Руководство пользователя. Руководство администратора Исходные коды на GitHub.	3 месяца с даты заключения договора
Открытое тестирование Системы и устранение замечаний	Система с исправленными замечаниями (релиз) размещенная и функционирующая на серверах. Актуализированные тесты Актуализированное руководство пользователя. Актуализированное руководство администратора. Актуализированный код на GitHub	2 месяца с даты окончания разработки

ПОРЯДОК КОНТРОЛЯ И ПРИЕМКИ СИСТЕМЫ

1. Взаимодействие между Заказчиком и Исполнителем осуществляется по каналам электронной почты и Skype.
2. Исполнитель назначает ответственное лицо, через которое осуществляется взаимодействие между Заказчиком и Исполнителем.
3. Исполнитель направляет Заказчику штатное расписание со следующей информацией: ФИО, должность, роль в команде, e-mail, Skype не позднее 1 дня с даты заключения договора..
4. Исполнитель отчитывается по поставленным вопросам Заказчика не позднее 8 рабочих часов (с 09:00 до 18:00 МСК) от момента поступления запроса.
5. Исполнитель участвует в публичном освещении результатов своей работы по видеоконференции Skype не реже одного раза в неделю. Исполнитель не возражает против публикации записи видеоконференции на YouTube.
6. Исполнитель выкладывает актуальную версию исходных кодов на GitHub не реже одного раза в день.
7. Тестирование системы начинается после достижения всех результатов этапа разработки.
8. Тестирование Системы проводится в открытой форме. Принять участие в тестировании могут все желающие.
9. Замечания к Системе и документации, выявленные  на этапе тестирования, участники тестирования публикуют на GitHub. Исполнитель устраняет замечания по мере поступления.
10. После устранения всех замечаний система переводится в промышленную эксплуатацию.

ТРЕБОВАНИЯ К ДОКУМЕНТИРОВАНИЮ

Общие требования к оформлению документов

Руководство пользователя и руководство администратора оформляются в соответствии с Markdown-нотацией и публикуются  на GitHub вместе с исходным кодом Системы.

Требования к Руководству пользователя

В Руководстве пользователя Подсистемы обязательно должны быть описаны:

• Требования к аппаратному обеспечению, требования к квалификации пользователя.
• Подготовка Системы к работе (пошаговая инструкция для запуска).
• Описание операций в виде пошаговой инструкции с подробно расписанными действиями пользователя. Действия пользователя должны сопровождаться снимком экрана , в котором должны быть выделены все значимые для пользователя элементы (экранные кнопки, рабочие области, различные интерфейсы) и указаны их функции и назначение.
• Аварийные ситуации и пошаговые инструкции действий пользователя в случае аварийных ситуаций.

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

В Руководстве администратора Подсистемы обязательно должны быть описаны:

• Общие принципы и логика работы Системы.
• Обязанности администратора и связанные с ними операции.
• Обязательность, регулярность и очередность выполнения всех операций.
• Порядок выполнения каждой операции.
• Проблемы в работе Системы и способы их решения.

ИСТОЧНИКИ РАЗРАБОТКИ

Исходными документами для разработки настоящего Технического задания являются:

• ГОСТ 34.602-89.
• Копные техники самоорганизации