Перейти к содержанию

CumberDoc: различия между версиями

Материал из Cumber Wiki
Нет описания правки
Строка 9: Строка 9:
# [[#Проектная документация|Проектная документация]]
# [[#Проектная документация|Проектная документация]]
## [[#Функциональная спецификация|Функциональная спецификация]]
## [[#Функциональная спецификация|Функциональная спецификация]]
## [[#Архитектура системы|Архитектура системы]]
## [[#Техническое задание|Техническое задание]]
# [[#Пользовательская документация|Пользовательская документация]]
# [[#Пользовательская документация|Пользовательская документация]]
## [[#Руководство пользователя|Руководство пользователя]]
## [[#Руководство пользователя|Руководство пользователя]]
## [[#Часто задаваемые вопросы|Часто задаваемые вопросы]]
## [[#Часто задаваемые вопросы|Часто задаваемые вопросы]]
## [[#Полезные ссылки|Полезные ссылки]]


----
----
Строка 93: Строка 92:
; '''Какие форматы видео поддерживаются?'''
; '''Какие форматы видео поддерживаются?'''
: MP4, MOV, AVI (до 100 МБ)
: MP4, MOV, AVI (до 100 МБ)
----
==== 2.3 Полезные ссылки ====
  * [[https://gitlab.xsserver.pro/|GitLab репозиторий Backend]]
  * [[https://miro.com/app/board/uXjVJIINayA=/?share_link_id=314129240131|Архитектура]]
  * [[https://jira.xsserver.pro/|Трекер задач (Jira)]]


----
----

Версия от 20:49, 25 сентября 2025

Cumberly - Платформа для обмена контентом

Логотип проекта Cumberly
Логотип проекта Cumberly

Оглавление

  1. Проектная документация
    1. Функциональная спецификация
  2. Пользовательская документация
    1. Руководство пользователя
    2. Часто задаваемые вопросы
    3. Полезные ссылки

1. Проектная документация

1.1 Функциональная спецификация

Cumberly - это современная социальная платформа для обмена контентом, которая позволяет пользователям:

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

1.1.1 Основные модули системы

Модуль Описание Приоритет
Авторизация Регистрация, вход, выход из системы Критический
Профиль Управление личными данными и аватаром Высокий
Посты Создание, редактирование, удаление постов Критический
Лента Отображение постов подписок Критический
Поиск Поиск по хештегам и пользователям Средний

1.1.2 Технические требования

  1. Платформы:
    • Web-версия (Flutter)
    • iOS приложение (Flutter)
    • Android приложение (Flutter)
  2. Backend: Go + Mongo + PostgreSQL + ...
  3. Инфраструктура: GitLab CI/CD, Docker

2. Пользовательская документация

2.1 Руководство пользователя

Быстрый старт

  1. Регистрация в системе
    • Перейдите на главную страницу
    • Нажмите кнопку "Регистрация"
    • Заполните форму:
      • Имя (до 30 символов)
      • Логин (3-30 символов, латиница)
      • Email
      • Пароль (минимум 8 символов)
  2. Создание первого поста
    • Нажмите на иконку "+"
    • Выберите фото или видео
    • Добавьте описание
    • Используйте #хештеги для категоризации
  3. Настройка профиля
    • Загрузите аватар
    • Добавьте описание профиля
    • Укажите интересы

Шаблон:Tip

Шаблон:Warning

2.2 Часто задаваемые вопросы (FAQ)

Как изменить пароль?
Перейдите в настройки профиля → Безопасность → Изменить пароль
Можно ли восстановить удаленный пост?
Нет, удаленные посты не подлежат восстановлению
Какие форматы видео поддерживаются?
MP4, MOV, AVI (до 100 МБ)

2.3 Полезные ссылки

 * [репозиторий Backend]
 * [[1]]
 * [задач (Jira)]