Анти-критерии для софта и апи
Jun. 2nd, 2012 12:03 pm![[personal profile]](https://www.dreamwidth.org/img/silk/identity/user.png)
В процессе срачей с айседом пришел к выводу, что искать идеальные софты/либы/платформы бесполезно, практически все, что хоть как-то используется - достаточно пригодно для использования. Лучше выделить критерии для того, что использовать нежелательно:
С точки зрения пользователя:
1) Отличие от общепринятых UI гайдлайнов. Например, розовый фон, красные кнопки, шрифт Comic Sans и выход из программы по кнопке F1.
2) Неадекватное поведение по отношению к другим программам и ОС. Например, встраивание хуков на системные действия или расширений в Explorer.
3) Издевательства над обычными средствами пользовательской интеграции - например, невозможность без вуду скопировать текст из программы в клипбоард, стандартным сочетанием кнопок или меню.
4) Наличие тупиков в Workflow, т.е. возможность обычными действиями зайти в программе туда, откуда обычными действиями уже не выйдешь (только снимать программу из диспетчера задач, kill и прочая)
5) Отсутствие прогресс-баров и прочей индикации выполнения при длительных операциях, отсутствие возможности их корректно прервать.
С точки зрения админства-деплоймента:
1) Неумение работать в многопользовательской среде/на терминальном сервере.
2) Неумение переживать xcopy-деплоймент и запускаться на чистой машине. В крайнем случае - должно быть документировано, что из окружения требуется (.net, жаба, переменные окружения)
3) Хардкодед пути в бинарниках - убивать нещадно.
4) Размещение своих либ/данных в общих папках, типа system32. Под линуксом - не считается, там за это пакетный менеджер, в идеале, отвечает и там принято всему софту гадить единообразно.
С точки зрения программизма:
0) ad-hoc программирование, без проектирования. Практически сразу заметно по структуре api.
1) Хардкодед значения, не являющиеся математическими константами. Пытать на дыбе авторов. Сюда же - хардкодед пути типа C:/Program Files или C:/openssl/etc (портированный софт
2) Тот же контекст, но в пределах ВСЕЙ ОС, а не только запущенного бинарника (Dragon Naturally Speaking и его апи - сука, ненавижу).
3) Не реентерабельные функции.
4) Отсутствие в АПИ для работы с внешними ресурсами явных пар типа Open/Close, Enter/Exit.
5) Невидимый/недокументированный/мутабельный глобальный контекст. Сюда же - использование такого контекста для работы с внешними ресурсами. Т.е. Open не возвращает "хендл для работы с ресурсом", а просто открывает где-то внутри его и все последующие функции его используют, неявно. Например, коннект к БД - один на всю программу. Или транзакция - одна на весь коннект к БД.
6) Отсутствие для значений getter там где присутствует setter. Забивать гвозди в голову за такое. Т.е. мы можем установить некий параметр, но не можем узнать его значение.
7) Случайное поведение API, не объяснимое переданными параметрами и документированным окружением. Обычно - следствие пункта 5 и общего рукожопия.
8) Использование GUI в явно не-гуишных либах. Последний пример - библиотека для работы с одной железякой, кидающая диалоговое окно при ошибке драйвера. Если ее использовать в фоновом сервисе - капец от входа.
9) Отсутствие в API возможности показать прогресс и прервать длительно выполняющиеся операции.
10) Отсутствие обработки ошибок вообще. УБИВАТЬ! УБИВАТЬ! УБИВАТЬ!
11) Обработка ошибок нормального workflow исключениями. Т.е. "попытка подключится к отсутствующему серверу" кидает исключение, хотя должна быть операция TryConnect
Хуже этого - только парсинг строк в простые значения без функции TryParse
12) Отсутствие логгинга. Сажать на кол, конечно же.
13) Отсутствие исходников - когда вышеописанное вылезет в полной мере, а автор окажется живущим половой жизнью с ежихой в ашраме Гуру Бхактиведанты Свами Прабхувады Ребе Короля Мошиаха - вам придется чинить либу самому.
За вас никто ничего чинить не будет - инфа 100%, еще ни одной либы не видел, где автор бы починил самоочевидную ошибку ранее чем через месяц после баг-репорта.
Т.е., если вы проектируете API - лучше сразу думайте, как его можно однозначно завернуть в красивый класс на c# или сделать обертку для него нахаскеле функциональном языке - резко становится очевидно, что можно делать и чего нельзя.
PS от
denisioru:
- невозможность запустить несколько инстансов софтины одновременно. Да, год 2012й. Лом в жопу.
- изобретение собственных IP-протоколов. Прикладной софт должен работать по UDP или TCP. В редких очевидных случаях - RTMP и иже с ними. Люто, бешено лоботомировать.
- использоать API ОС для ресолвинга имён. За формирование руками DNS запросов и отправку их в неизвестном направлении - насылать нещадный кровавый понос.
- использование нестандартных диалогов открытия и сохранения файлов. Как наказание - выдать блок питания к ноуту юзера, несовместимый с розетками в офисе и дома.
- глюки на мультимониторных конфигурациях. За появление главного окна софтины, напополам распиленное между десктопами - выкалывать глаза.
- создание и использование временных файлов ВНЕ системного каталога TEMP - отправлять сортировать мусорные баки.
PS от
belnetmon:
- невозможность запустить софтину под уровнем пользователя , отличного от админа
- невозможность работы с UNC путями
- гадить во временную папку, которую пидор создал в корне системного диска (NVidia, Intel - привет)
С точки зрения пользователя:
1) Отличие от общепринятых UI гайдлайнов. Например, розовый фон, красные кнопки, шрифт Comic Sans и выход из программы по кнопке F1.
2) Неадекватное поведение по отношению к другим программам и ОС. Например, встраивание хуков на системные действия или расширений в Explorer.
3) Издевательства над обычными средствами пользовательской интеграции - например, невозможность без вуду скопировать текст из программы в клипбоард, стандартным сочетанием кнопок или меню.
4) Наличие тупиков в Workflow, т.е. возможность обычными действиями зайти в программе туда, откуда обычными действиями уже не выйдешь (только снимать программу из диспетчера задач, kill и прочая)
5) Отсутствие прогресс-баров и прочей индикации выполнения при длительных операциях, отсутствие возможности их корректно прервать.
С точки зрения админства-деплоймента:
1) Неумение работать в многопользовательской среде/на терминальном сервере.
2) Неумение переживать xcopy-деплоймент и запускаться на чистой машине. В крайнем случае - должно быть документировано, что из окружения требуется (.net, жаба, переменные окружения)
3) Хардкодед пути в бинарниках - убивать нещадно.
4) Размещение своих либ/данных в общих папках, типа system32. Под линуксом - не считается, там за это пакетный менеджер, в идеале, отвечает и там принято всему софту гадить единообразно.
С точки зрения программизма:
0) ad-hoc программирование, без проектирования. Практически сразу заметно по структуре api.
1) Хардкодед значения, не являющиеся математическими константами. Пытать на дыбе авторов. Сюда же - хардкодед пути типа C:/Program Files или C:/openssl/etc (портированный софт
2) Тот же контекст, но в пределах ВСЕЙ ОС, а не только запущенного бинарника (Dragon Naturally Speaking и его апи - сука, ненавижу).
3) Не реентерабельные функции.
4) Отсутствие в АПИ для работы с внешними ресурсами явных пар типа Open/Close, Enter/Exit.
5) Невидимый/недокументированный/мутабельный глобальный контекст. Сюда же - использование такого контекста для работы с внешними ресурсами. Т.е. Open не возвращает "хендл для работы с ресурсом", а просто открывает где-то внутри его и все последующие функции его используют, неявно. Например, коннект к БД - один на всю программу. Или транзакция - одна на весь коннект к БД.
6) Отсутствие для значений getter там где присутствует setter. Забивать гвозди в голову за такое. Т.е. мы можем установить некий параметр, но не можем узнать его значение.
7) Случайное поведение API, не объяснимое переданными параметрами и документированным окружением. Обычно - следствие пункта 5 и общего рукожопия.
8) Использование GUI в явно не-гуишных либах. Последний пример - библиотека для работы с одной железякой, кидающая диалоговое окно при ошибке драйвера. Если ее использовать в фоновом сервисе - капец от входа.
9) Отсутствие в API возможности показать прогресс и прервать длительно выполняющиеся операции.
10) Отсутствие обработки ошибок вообще. УБИВАТЬ! УБИВАТЬ! УБИВАТЬ!
11) Обработка ошибок нормального workflow исключениями. Т.е. "попытка подключится к отсутствующему серверу" кидает исключение, хотя должна быть операция TryConnect
Хуже этого - только парсинг строк в простые значения без функции TryParse
12) Отсутствие логгинга. Сажать на кол, конечно же.
13) Отсутствие исходников - когда вышеописанное вылезет в полной мере, а автор окажется живущим половой жизнью с ежихой в ашраме Гуру Бхактиведанты Свами Прабхувады Ребе Короля Мошиаха - вам придется чинить либу самому.
За вас никто ничего чинить не будет - инфа 100%, еще ни одной либы не видел, где автор бы починил самоочевидную ошибку ранее чем через месяц после баг-репорта.
Т.е., если вы проектируете API - лучше сразу думайте, как его можно однозначно завернуть в красивый класс на c# или сделать обертку для него на
PS от
![[livejournal.com profile]](https://www.dreamwidth.org/img/external/lj-userinfo.gif)
- невозможность запустить несколько инстансов софтины одновременно. Да, год 2012й. Лом в жопу.
- изобретение собственных IP-протоколов. Прикладной софт должен работать по UDP или TCP. В редких очевидных случаях - RTMP и иже с ними. Люто, бешено лоботомировать.
- использоать API ОС для ресолвинга имён. За формирование руками DNS запросов и отправку их в неизвестном направлении - насылать нещадный кровавый понос.
- использование нестандартных диалогов открытия и сохранения файлов. Как наказание - выдать блок питания к ноуту юзера, несовместимый с розетками в офисе и дома.
- глюки на мультимониторных конфигурациях. За появление главного окна софтины, напополам распиленное между десктопами - выкалывать глаза.
- создание и использование временных файлов ВНЕ системного каталога TEMP - отправлять сортировать мусорные баки.
PS от
![[livejournal.com profile]](https://www.dreamwidth.org/img/external/lj-userinfo.gif)
- невозможность запустить софтину под уровнем пользователя , отличного от админа
- невозможность работы с UNC путями
- гадить во временную папку, которую пидор создал в корне системного диска (NVidia, Intel - привет)
no subject
Date: 2012-06-02 09:15 am (UTC)no subject
Date: 2012-06-02 09:31 am (UTC)no subject
Date: 2012-06-02 09:32 am (UTC)зачем ви так ненавидите каснерика?
no subject
Date: 2012-06-02 09:38 am (UTC)(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 10:09 am (UTC)(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:ИТ - гуманитарная дисциплина
From:Re: ИТ - гуманитарная дисциплина
From:Re: ИТ - гуманитарная дисциплина
From:Re: ИТ - гуманитарная дисциплина
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 10:20 am (UTC)no subject
Date: 2012-06-03 06:28 am (UTC)Не то, что у нас!
no subject
Date: 2012-06-02 10:33 am (UTC)no subject
Date: 2012-06-02 10:35 am (UTC)no subject
Date: 2012-06-02 10:50 am (UTC)Или когда открыл какое-то окно, но выйти можно только нажав OK, что вызовет побочный эффект сохранения изменений. Т.е. формально это не тупик, но выйти из него можно только через потенциально деструктивные действия.
(no subject)
From:no subject
Date: 2012-06-02 10:53 am (UTC)no subject
Date: 2012-06-02 11:28 am (UTC)А раскладывать говно по полочкам - задолбаешься потом его вычищать.
(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 11:11 am (UTC)Ога. Имплементировать надо решение, а не проблему. А то и выходит бабушка с бородой и хвостом жучки, которую внезапно надо расширить и впихнуть куда-то репку. Правда, стоит заметить, те люди, которые так на голубом глазу поступают, если вдруг открывают для себя проектирование (сперва в лице дизайн паттерном, прости господи), то лучше от этого никак не становится:-)
no subject
Date: 2012-06-02 02:27 pm (UTC)(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 11:17 am (UTC)О, я вам расскажу еще за интерсепторы. Значит, прилетает в наше ОПИ некий идентификатор, согласно сигнатуре типа #уй, но интерсептор, который надо ручками прописывать в виде аннотации (и не дай бог забудешь) к каждому нужному методу, кроме прочих шаманских ритуалов, берет этот идентификатор, превращает его в палец и сует в ту же переменную, называющуюся #уй, и в результате в теле метода мы имеем в переменной #уй уже палец:-) Экая архитектурная сила мысли!
no subject
Date: 2012-06-02 11:26 am (UTC)- изобретение собственных IP-протоколов. Прикладной софт должен работать по UDP или TCP. В редких очевидных случаях - RTMP и иже с ними. Люто, бешено лоботомировать.
- использоать API ОС для ресолвинга имён. За формирование руками DNS запросов и отправку их в неизвестном направлении - насылать нещадный кровавый понос.
- использование нестандартных диалогов открытия и сохранения файлов. Как наказание - выдать блок питания к ноуту юзера, несовместимый с розетками в офисе и дома.
- глюки на мультимониторных конфигурациях. За появление главного окна софтины, напополам распиленное между десктопами - выкалывать глаза.
- создание и использование временных файлов ВНЕ системного каталога TEMP - отправлять сортировать мусорные баки.
no subject
Date: 2012-06-02 11:31 am (UTC)Про ручные ДНС запросы - класс. Никогда такого не видел :)
А зачем вообще резолвить что-то руками? Это ж системное дело, адрес этот хост или имя.. На прикладном уровне вообще об этом не надо думать.
Нестандартные диалоги открытия - это может быть наследование каких-нибудь кросс-платформенных библиотек, жабы и т.п. Они грешат этим зело.
А вот по последнему пункту - уточните. "Системный каталог" у вас - это что?
(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 11:33 am (UTC)- невозможность запустить софтину под уровнем пользователя , отличного от админа
- невозможность работы с UNC путями
- гадить во временную папку, которую пидор создал в корне системного диска (NVidia, Intel - привет)
no subject
Date: 2012-06-02 11:57 am (UTC)(no subject)
From:(no subject)
From:no subject
Date: 2012-06-02 11:47 am (UTC)Срач возможен знатный ))
no subject
Date: 2012-06-02 12:04 pm (UTC)(no subject)
From:(no subject)
From:Анти-критерии для софта и апи
Date: 2012-06-02 12:56 pm (UTC)no subject
Date: 2012-06-02 01:21 pm (UTC)- Использование символов с кодами больше 127 в именах файлов внутри неюникодных контейнеров (.zip, ...)
- Библиотеки локального назначения, шарящие по глобальным ресурсам машины (дырявая libxml и иже с ней)
no subject
Date: 2012-06-04 10:43 am (UTC)Там единственное, что плохо - совершенно рукожопная работа с HTTP, один способ указания прокси чего стоит. С год назад отправлена в АдЪ и Израиль, где Жыды, и заменена (sic!) на WinHTTP.
(no subject)
From:no subject
Date: 2012-06-02 01:35 pm (UTC)Ну и до кучи - создание многопользовательских софтин с локом на файлы.Очень чудесно, кода клиент у кого завис, а еще 100500 полчают отлуп, потому как файл конфига общий на чтение залочен. Ну и да, хранение конфигов клиентских в местах, отличных от пользовательских папок, для того и предназначеных.
no subject
Date: 2012-06-02 02:06 pm (UTC)а то ваш пост мне почему-то коррелирует с этой книжкой ;-) Впрочем, как и часть комментов по существу.
no subject
Date: 2012-06-02 02:42 pm (UTC)(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-03 12:10 am (UTC)А можете пояснить, чем вам не нравится просто метод Connect(..) бросающий Exception вида CannotConnectToMyCoolServer? Совсем не вижу что в этом плохого.
no subject
Date: 2012-06-03 05:13 am (UTC)И это исключение приходится перехватывать практически всегда и переводить на нормальный язык для пользователя.
(no subject)
From:(no subject)
From:(no subject)
From:(no subject)
From:no subject
Date: 2012-06-03 02:42 pm (UTC)подразумевается что всегда есть альтернатива? это не так.
no subject
Date: 2012-06-04 09:16 am (UTC)no subject
Date: 2012-06-04 09:32 am (UTC)(no subject)
From:No title
Date: 2012-06-04 12:07 pm (UTC)no subject
Date: 2012-06-10 07:43 pm (UTC)Несколько спорный пункт. Виндовые диалоги - это если не маразм, то дебилизм - точно. Пример на винде-7: КАЖДЫЙ раз, когда нужно что-то сохранить, эта тварь мне суёт Desktop/Libraries/Documents - дура штоле?! У меня ДВА места для сохранения - C: и D:! Которые конечно видны в дереве слева, но они... СПРЯТАНЫ! И "колесо прокрутки" там не пашет без фокуса! Там же сидит "сидиром", на который в здравом уме никто писать не будет, но тем не менее он стоит.
Короче, мудак, проектировавший эти диалоги заслуживает всех вышеперечисленных наказаний.
no subject
Date: 2012-06-11 04:30 pm (UTC)no subject
Date: 2012-06-11 04:42 pm (UTC)- отсутствие функциональных тестов, хотя бы по одному на фичу
- отсутствие юнит-тестов для хотя бы библиотечных функций
- зависимость библиотечных функций от глобального состояния приложения и прочие "запутанные графы объектов", усложняющие тестирование
no subject
Date: 2012-06-13 03:44 pm (UTC)no subject
Date: 2012-06-13 04:18 pm (UTC)