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

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

Материал из Cumber Wiki
Нет описания правки
Нет описания правки
Метка: ручная отмена
 
(не показано 37 промежуточных версий 3 участников)
Строка 1: Строка 1:
= Cumberly - Платформа для обмена контентом =
[[File:logo_Cumberly.png|200px|right|Логотип проекта Cumberly]]
[[File:logo_Cumberly.png|200px|right|Логотип проекта Cumberly]]
'''Cumberly''' - современная социальная платформа для обмена контентом.


----
__TOC__
 
== Оглавление ==
 
# [[#Проектная документация|Проектная документация]]
## [[#Функциональная спецификация|Функциональная спецификация]]
# [[#Пользовательская документация|Пользовательская документация]]
## [[#Руководство пользователя|Руководство пользователя]]
## [[#Часто задаваемые вопросы|Часто задаваемые вопросы]]
## [[#Полезные ссылки|Полезные ссылки]]
 
----
 
== 1. Проектная документация ==


=== <span style="color:#4169E1">1.1 Функциональная спецификация</span> ===
= {{ЗаголовокЦветом|1|#FF0000|Проектная документация}} =


=== Функциональная спецификация ===
'''Cumberly''' - это ''современная социальная платформа'' для обмена контентом, которая позволяет пользователям:
'''Cumberly''' - это ''современная социальная платформа'' для обмена контентом, которая позволяет пользователям:
* Создавать и публиковать посты с фото и видео
* Создавать и публиковать посты с фото и видео
* Подписываться на интересных авторов
* Подписываться на интересных авторов
* Взаимодействовать через лайки и комментарии
* Взаимодействовать через лайки и репосты
* Искать контент по хештегам
* Искать контент по хештегам


==== 1.1.1 Основные модули системы ====
==== Основные модули системы ====
 
{| class="wikitable"
{| class="wikitable"
|-
|-
! Модуль !! Описание !! Приоритет
! Модуль !! Описание
|-
|-
| '''Авторизация''' || Регистрация, вход, выход из системы || Критический
| '''Авторизация''' || Регистрация, вход, выход из системы
|-
|-
| '''Профиль''' || Управление личными данными и аватаром || Высокий
| '''Профиль''' || Управление личными данными и аватаром
|-
|-
| '''Посты''' || Создание, редактирование, удаление постов || Критический
| '''Посты''' || Создание, редактирование, удаление постов
|-
|-
| '''Лента''' || Отображение постов подписок || Критический
| '''Лента''' || Отображение постов подписок
|-
|-
| '''Поиск''' || Поиск по хештегам и пользователям || Средний
| '''Поиск''' || Поиск по хештегам и пользователям
|}
|}


==== 1.1.2 Технические требования ====
==== Технические требования ====
 
# '''Платформы''':  
# '''Платформы''':  
#* Web-версия (Flutter)
#* Web-версия (Flutter)
Строка 52: Строка 37:
# '''Инфраструктура''': GitLab CI/CD, Docker
# '''Инфраструктура''': GitLab CI/CD, Docker


----
= {{ЗаголовокЦветом|1|#32CD32|Пользовательская документация}} =
 
== 2. Пользовательская документация ==


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


==== Быстрый старт ====
==== Быстрый старт ====
# '''Регистрация в системе'''
# '''Регистрация в системе'''
#* Перейдите на главную страницу
#* Перейдите на главную страницу
Строка 78: Строка 60:
#* Укажите интересы
#* Укажите интересы


{{Tip|text='''Совет:''' Используйте хештеги для увеличения охвата ваших постов!}}
{| class="wikitable" style="background-color: #F9F9F9; border: 1px solid #AAAAAA;"
| '''Совет:''' Используйте хештеги для увеличения охвата ваших постов!
|}
 
{| class="wikitable" style="background-color: #FFCCCC; border: 1px solid #AA0000;"
| '''Внимание:''' Максимальный размер видео - 100 МБ
|}
 
= {{ЗаголовокЦветом|1|#4169E1|Обсуждения и предложения}} =


{{Warning|text='''Внимание:''' Максимальный размер видео - 100 МБ}}
Обсуждения и предложения по структуре и содержанию страницы находятся по [[Обсуждение:CumberDoc|ссылке]]


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


=== Часто задаваемые вопросы (FAQ) ===
; '''Как изменить пароль?'''
; '''Как изменить пароль?'''
: Перейдите в настройки профиля → Безопасность → Изменить пароль
: Перейдите в настройки профиля → Безопасность → Изменить пароль
Строка 93: Строка 84:
: MP4, MOV, AVI (до 100 МБ)
: MP4, MOV, AVI (до 100 МБ)


=== 2.3 Полезные ссылки ===
=== Полезные ссылки ===
 
* [https://gitlab.xsserver.pro/ GitLab репозиторий Backend]
* [https://gitlab.xsserver.pro/ GitLab репозиторий Backend]
* [https://miro.com/app/board/uXjVJIINayA=/?share_link_id=314129240131 Архитектура]
* [https://miro.com/app/board/ Архитектура]
* [https://jira.xsserver.pro/ Трекер задач (Jira)]
* [https://jira.xsserver.pro/ Трекер задач (Jira)]
* [https://wiki.xsserver.pro/index.php/%D0%9E%D0%B1%D1%81%D1%83%D0%B6%D0%B4%D0%B5%D0%BD%D0%B8%D0%B5:CumberDoc / Обсуждения и предложения]
 
== См. также ==
* [[Руководство администратора]]
* [[API документация]]
* [[Changelog]]
 
[[Категория:Проекты]]
[[Категория:Социальные платформы]]
[[Категория:Документация]]

Текущая версия от 21:47, 25 сентября 2025

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

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

Проектная документация[править]

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

[править]

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

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

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

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

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

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

Пользовательская документация[править]

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

[править]

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

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

Обсуждения и предложения[править]

Обсуждения и предложения по структуре и содержанию страницы находятся по ссылке


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

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

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

[править]

См. также

[править]