Пример грамотного оформления описания проекта

Пример оформления описания на основе текста группы IDK, 1 курс: 
 

Предисловие: Сейчас в университете большое количество студенческих объединений. Стоит отметить, что количество участников в каждом из них очень сильно отличается, и поэтому сообщества, где больше участников имеют большую медийность и как следствие большее количество участников на своих мероприятиях. Соответственно для людей с более узкими интересами становится намного сложнее найти те активности, которые им будут интересны. А также важно заметить, что есть люди, которые сами хотят организовать своё небольшое "мероприятие" (будь то вечер настольных игр на 4-х человек или коллективный поход в кино), но у таких людей может совсем не быть медийного ресурса, а значит для них является большой проблемой найти себе компанию для этих активностей. И из этого вытекает следующая проблема...

Проблема: В университете очень сложно создать своё небольшое мероприятие так, чтобы о нём узнало много людей.

Наше решение: Web-сервис по организации подобных небольших активностей, где каждый студент может создать своё "мероприятие".

Пояснение: Благодаря этому сервису студентам будет проще самоорганизоваться, а также завести новые знакомства в университете(особенно актуально для студентов 1 курса), ну и конечно подобный сервис сделает внеучебную студентов и университета интереснее и разнообразнее.

Пример использования: Иван(студент 1 курса) собирается в поход выходного дня. К сожалению, его друзья не могут составить ему комп

анию по разным причинам, а одному в подобный поход идти намного сложнее. Для того, чтобы найти себе напарников для похода, Ваня создал в нашем сервисе запись, где указал информацию о своём походе, добавив, что ему необходимо ещё 3 человека в поход, а также оставил свои контакты. В этот же день Николай(студент 3 курса) увидел в нашем сервисе, что в выходные студент 1 курса Иван организует поход выходного дня. Николай обожает такие активности и готов составить Ивану компанию в его путешествии. Он связывается с ним по контактам, которые Иван оставил в записи. Позже к ним присоединяется ещё 2 человека, тоже студенты университета. Как итог у ребят получилось организовать отличный поход выходного дня, а также Иван смог найти себе новых друзей в университете.

Перспективы: Создание мобильного приложения, а также постоянное добавление функционала в Web-сервис. А также наш сервис будет удобен как для индивидуальных пользователей, так и для тех самых маленьких студенческих объединений с небольшой медийностью, о которых упоминается в предисловии. Большим преимуществом будет являться постоянно увеличивающаяся база пользователей приложения, поскольку можно предположить, что после первого удачного опыта организации мероприятия через наш сервис, всё больше людей захотят организовать что-то сами, чем привлекут дополнительную аудиторию. И именно поэтому количество пользователей будет постоянно расти.

MVP: Web-сервис с регистрацией пользователя (в перспективе регистрация через ВК), где можно увидеть в удобной форме все мероприятия, которые организуют студенты в ближайшие несколько дней. Мероприятия можно отобразить по некоторым фильтрам (например: по виду мероприятия (кино, спорт, прогулка и прочее), по количеству участников, а также другие фильтры). Возможность создать своё мероприятие с указанием даты, места, времени и максимального количества участников. Информация о мероприятии также обязательно включает в себя общее описание предстоящего события и контакты организатора. На странице каждого мероприятия есть кнопка "Участвовать", нажав на которую данное событие добавляется в список "Мои мероприятия". Также сервис имеет адаптивную верстку, что позволяет удобно его использовать на разных типах устройств.
И если мы успеем сделать это, то тогда в первую очередь планируем добавить в наш сервис уведомления для мероприятий, в которых пользователь планирует участвовать. Данные уведомления можно будет настроить. А также ещё несколько других функций, которые несомненно будут полезны для пользователей нашего сервиса.

Стек технологий (еще будет дополняться): 

Система контроля версий: Git, GitHub.
Прототипирование и дизайн: Figma, AdobePhotoshop, Adobe Illustrator, ...
Работа с Front-end и Back-End: Visual Studio 2017, Visual Studio Code (+ extensions).
Back-end: C#, ASP.NET, SQL, MS SQL Server, ...
Front-end: NodeJS, React, JavaScript, TypeScript*, XML, HTML, CSS, Sass*

Примечание: Более подробной информации о технических особенностях реализации нашего проекта на данный момент нет, потому что мы ещё решаем в команде, как это будет сделать быстрее и удобнее. И конечно же мы открыты для рекомендаций и предложений, а также ждем критики.

© ФГАОУ ВО «УРФУ ИМЕНИ ПЕРВОГО ПРЕЗИДЕНТА РОССИИ Б.Н. ЕЛЬЦИНА»