Пользователь главный

Код нужен для того, чтобы им пользовались. Его цель – сделать пользователю удобно.

То, что задачи учебные и едва ли кто-то будет всерьёз ими пользоваться – не важно. Любой код должен быть удобен для пользователя.

Это значит, что у каждой задачи:

  • должна быть документация. Что это, зачем, как запускать, какие файлы откуда надо скачать, что произойдёт и подобные вопросы в ней должны быть освещены. Это кажется ненужным ("кам он, это же учебные задачки"), но это не так. Доведение любой поделки до вменяемого состояния – такой же навык, как умение программировать и его необходимо развивать. Подробнее про документацию.
  • не должно быть захардкоженых путей до файлов. Их же нет у пользователя! Напиши, где их взять, сделай путь параметром, опиши в --help, как им пользоваться.
  • не должно быть лишних обязательных параметров. Параметризировать – хорошо, но заставлять пользователя указывать все параметры – плохо. Лучше сделать необходимыми минимум параметров, а для остальных проставить значения по-умолчанию и написать об этом в документации.
  • объяснять, что происходит. Если скрипт выводит друзей онлайн, он должен говорить, что это друзья пользователя, которые сейчас онлайн. Выводит самый большой бар – должен писать, что это – самый большой бар.

Заботься о пользователе