Справочники и инструкции
Приветствуем!
Хотите что-то написать?Нужно назвать себя.
Если вы пришли в первый раз,
то нужно зарегистрироваться.
Читайте нас в:
Бред → Справочники и инструкции
Есть такая шутка, что в компаниях разрабатывающих ПО, определили, что в России, судя по скорости прочтения и принятия License Agreement, самые быстро читающие пользователи.
Также, вспоминается история про эксперимент с наградой в несколько килодолларов, которую анонсировали где-то в тексте пользовательского соглашения, любому, кто первым позвонит по указанному разработчиком номеру... никто так и не позвонил.
Да к тому, что в технической документации, инструкциях, соглашениях могут встречаться всевозможные ляпы или сюрпризы, которые так никогда никем и не читаются.
В нашей практике такой забавный ляп имел место быть – это был блок инструкции посвященный работе с модулем CMS нашего предыдущего самописного фреймворка в основе которого была ORM (Doctrine).
То, что обнаружили этот веселый фрагмент инструкции мы сами, говорит наверное о том, что созданные нами интерфейсы не нуждались в обращении к написанной инструкции и её справочнику. Что не может не радовать.
Корни этой истории уходят в 2007 год когда студия запускала первый проект на доктриновском фреймворке - сайт итальянской косметики Ganassini (красивые девушки, полезная разноплановая косметика для женской красоты и здоровья).
Именно тогда в справочном блоке новой инструкции к CMS появился раздел, посвященный тегу ссылки (для желающих покопаться в html-view).
Оказалось что некоторые фрагменты этого справочника для примера использовали материалы сайта ganassini, а справочник был частью общей персональной инструкции проекта.
Т.к. справочник не был связан непосредственно со спецификой проекта, то до момента нашего перехода на symfony он кочевал из проекта в проект.
На днях к своему великому изумлению мы в нем нашли такой вот веселый фрагмент…
.jpg)
Видимо наш тех. писатель был тогда в хорошем расположении духа если выбрал для примера такую занимательную статью :-).
Невольно ловишь себя на мысли, что когда продукт написан по-человечески и все интуитивно понятно в инструкцию хоть половину майн кампфа можно засовывать :-))) ... так и останется незамеченным.