From cc44bdf068d346b96ea2161032dee649398d6763 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D1=82=D0=B5=D0=BF=D0=B0=D0=BD=D0=B5=D0=BD=D0=BA?= =?UTF-8?q?=D0=BE=20=D0=9E=D0=BB=D1=8C=D0=B3=D0=B0?= Date: Thu, 18 Feb 2021 11:44:13 +0300 Subject: [PATCH] Add template of users documentation --- docs/source/code.rst | 5 +++++ docs/source/index.rst | 11 +---------- docs/source/overview.rst | 18 ++++++++++++++++++ docs/source/todo.rst | 5 +++++ 4 files changed, 29 insertions(+), 10 deletions(-) create mode 100644 docs/source/overview.rst diff --git a/docs/source/code.rst b/docs/source/code.rst index 246e791..85d207b 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -1,3 +1,7 @@ +Документация разработчика +========================= + + ****** Models ****** @@ -13,6 +17,7 @@ Forms .. automodule:: main.forms :members: + *************** Extra Functions *************** diff --git a/docs/source/index.rst b/docs/source/index.rst index 4cbdce9..83cf46a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,20 +6,11 @@ Welcome to ZenDesk Access Controller's documentation! ===================================================== -Структура документации: ------------------------ - -Документация пользователя -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Документация разработчика -~~~~~~~~~~~~~~~~~~~~~~~~~ - - .. toctree:: :maxdepth: 2 :caption: Contents: + overview code todo diff --git a/docs/source/overview.rst b/docs/source/overview.rst new file mode 100644 index 0000000..447e273 --- /dev/null +++ b/docs/source/overview.rst @@ -0,0 +1,18 @@ + +Документация пользователя +========================= + +**Управление правами доступа** + + +**ZenDesk Access Controller** - Web-приложение, для выдачи прав пользователям системы по запросу самого пользователя. + +Например, из 12 человек 3 сейчас работают с правами администратора, по окончании рабочей смены они сдают свои права (освобождают места) и другие пользователи могут запросить эти права в свое пользование. + +Оставшиеся 9 человек получают права легкого агента - без прав редактирования, а только чтение. + +**Интерфейс пользователя:** + + + +.. |copy| unicode:: 0xA9 .. Школа программистов S101, группа 2. 2021гю diff --git a/docs/source/todo.rst b/docs/source/todo.rst index 64946f9..a8d024b 100644 --- a/docs/source/todo.rst +++ b/docs/source/todo.rst @@ -1,3 +1,8 @@ +Что необходимо доделать? +======================= + + + ***** TODOs *****