Покайтесь друг другу публично!

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

В частности, родил преподробную документацию по криво слепленному на колене за пару дней полгода назад баннерному движочку. Мне всегда очень стыдно отдавать свой код на чужие глаза, особенно если изначально оно предназначалось исключительно для внутреннего применения, но делать ничего не оставалось…

Руководство по эксплуатации системы обмена рекламными баннерами сайта nnnnn.ru

.
(печатается с сокращениями)

1. Назначение системы.
~~~~~~~~~~~~~~~~~~~~~~
Система предназачена:
— для эффективного показа мудацких баннеров в форматах gif, jpeg, flash на страницах сайта. Прочие форматы добавляются опционально.
— для перенаправления пользователей, имевших глупость кликнуть мышью на мудацкий баннер, в известное место.
— для учета показов, кликов и расчета эффективности конкретного мудацкого баннера.
— для генерации и показа маленькой и убогой страницы с данными, указанными в предыдущем пункте.

Система не предназначена:
— для какого бы то ни было распределения баннерных показов по географическому, национальному, первичному половому, вторичному половому и прочим признакам.
— для сбора какой-либо дополнительной информации о пользователях, имевших несчастье подвергнуться показу мудацкого баннера, а равно и о пользователях, имевших глупость на мудацкий баннер кликнуть.
— для услаждения зрения, слуха, обоняния, осязания и вкуса как вышеупомянутых пользователей, так и коллектива разработчиков, администраторов, контент-менеджеров, редакторов сайта а также их потенциальных рекламодателей.
— для облегчения жизни и труда всем вышеуказанным категориям лиц.

Если вам кажется, что это выглядит, как дерьмо, вы не ошибаетесь. Это действительно дерьмо. Попробуйте написать лучше.

2. Описание системы.
~~~~~~~~~~~~~~~~~~~~
Система состоит из следующих компонентов:
— Базы данных «basename» на сервере MySQL.
— Perl-cкриптов xxxxx.cgi и yyyyy.cgi, исполняемых сервером Apache. Если вам непонятно одно из использованных в этом разделе слов, можете не читать дальше.
— комплекта идиотских шаблонов, оставшихся в наследство от предыдущей команды разработчиков.

В базе данных хранятся сведения об баннерных аккаунтах (один баннер — один аккаунт) и статистика их показов.

xxxx.cgi — основной баннерный движок. Параметры вызова:
xxxx.cgi?n=12 (показывает баннер номер 12)
xxxx.cgi?n=12&x=1 (показывает редирект на url, указанный в настройках баннера номер 12)
xxxx.cgi (показывает хуй)

yyyy.cgi — демонстрация убогой статистики. Параметры вызова:
yyyy.cgi?n=12 (показывает убогую статистику аккаунта номер 12)
yyyy.cgi (показывает хуй)

4. Интерфейс администрирования системы.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Убогий интерфейс для администрирования системы (сюрприз! сюрприз!) еще не написан.

5. Добавление (редактирование) баннера.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Чтобы добавить баннер, следует выполнить следующие четыре операции:
(здесь, собственно, и были те две строчки, ради которых вся эта чушь и писалась).

А как Вы пишете внутрифирменную техдокументацию?


Комментарии:

Покайтесь друг другу публично!: 2 комментария

    1. Во-первых, в постинге опущен третий раздел (формат баз и прочее хренение информации) целиком и убраны прочие интимные подробности (из параноидальных соображений).

      Во-вторых, так Вы ж меня и старше… :))

Комментарии запрещены.