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

Техническое задание

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

Tip

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

TodoBot

Предназначен для составления списка задач и напоминаний с указанным временем и автоматическим преждевременным уведомлением о них. Бот работает как в беседах, так и в личных сообщениях

Команды

Добавляет в список всех дел новое без времени и без метки "важное"

Префиксы
  • .
  • !
Имена
  • add
  • заметка
Аргументы
Тип Описание
Строка Текст заметки
Примеры

.add Купить машину
.заметка Написать крутого бота на vkquick

В ответе команды должна быть кнопка Пометить как важное

Помечает задачу как "важное" или снимает эту метку с помощью ID задачи

Префиксы
  • .
  • !
Имена
  • imp
  • важно
Аргументы
Тип Описание
Число ID заметки
Примеры

!imp 111
!важно 3345

Помечает задачу как "выполненное" или снимает эту метку с помощью ID задачи

Префиксы
  • .
  • !
Имена
  • done
  • сделано
Аргументы
Тип Описание
Список чисел ID заметок, которых нужно пометить как выполненные
Примеры

!imp 111
!важно 3345

Показывает все задачи. Если задач много, высылает текстовый файл

Префиксы
  • .
  • !
Имена
  • all
  • все
Примеры

!all
!все

Note

С каждым днем я буду добавлять все больше и больше команд

Todo

Возможно, было бы неплохо, если бы такая "документация" генерировалась автоматически на основе вашего кода