1. Purpose
Целью этого документа является предоставить исчерпывающие требования к продукту “AnimeUpdatesBot”, при выполнении которых его первая версия, обладающая минимальным функционалом, достаточным для удовлетворения первых потребителей, может считаться успешно завершенной. Далее представлены требования к программной реализации и интерфейсу продукта.
3. Definitions, Acronyms, and Abbreviations
- Telegram-bot - это сторонние приложения, которые запускаются внутри мессенджера Telegram. Пользователи могут взаимодействовать с ботами, отправляя им сообщения, команды и встроенные запросы. Вы управляете своими ботами, используя HTTPS-запросы к Telegram Bot API;
- API - это программный интерфейс приложений, набор инструкций, который позволяет разным приложениям общаться между собой;
- REST API - архитектурный подход для создания API, вводящий правила написания кода серверного приложения;
- Python - высокоуровневый язык программирования общего назначения с динамической строгой типизацией и автоматическим управлением памятью;
- MongoDB - документо-ориентированная система управления базами данных, не требующая описания схемы таблиц;
- MIT License - лицензия открытого и свободного программного обеспечения, разработанная Массачусетским технологическим институтом;
4. References
- MyAnimeList - крупнейший сайт с информацией об аниме и манге.
- Jikan - неофициальное REST API для работы с myanimelist. Документация.
- JikanPy - Python Wrapper для работы с Jikan. Github.
- MIT License - используемая лицензия.
- PEP-8 - Style-guide для Python.
5. Overview
Далее документ содержит два основных раздела: общее описание (Overall Description) продукта “AnimeUpdatesBot” и технические требования к его реализации (Specific Requirements).