Документация для разработчиков по версии 2

Друзья!
Документация для разработчиков на базе InstantCMS v.2 получается не на шутку хороша!
Однако, её написание замерло "на самом интересном месте", причём, уже довольно давно.
Согласен, ситуацию немного поправила публикация видео, где автор гениально разрабатывает компонент "в реальном времени", но всё же тот набор статей, которые уже написаны, подсказывает, что продолжение было бы важным систематизирующим фактором для разработчиков сайтов...
Я прекрасно понимаю, что автору этих лаконичных, но ёмких и внятных статей страшно некогда – надо ведь и деньги зарабатывать, а писать мануалы, да ещё и для "конкурентов" – дело неблагодарное...

Но у меня есть ДЕЛОВОЕ ПРЕДЛОЖЕНИЕ:
давайте все те, кто заинтересован в завершении этой справочной публикации, скинемся всем миром – кто сколько сможет – конкретно именно на оплату этой важной работы!
Эта работа вполне обозрима и автору она, безусловно, понятна и проста – главное ресурс времени!
Зная, что народ проголосовал рублём, надеюсь, уважаемому автору будет легче сдвинуть этот сизифов камень с места...

Чисто технически это можно сделать так:
перевести деньги по номерам счетов (на Яндекс-деньгах и на Веб-манях), указанных на странице Поддержать проект и при этом сообщить в примечании к переводу, что это конкретно за работу над документацией для разработчиков i-cms-2.

Хорошая документация была бы стимулом для новых и уже существующих разработчиков писать различные дополнения ко второй ветке инстанта, что в свою очередь, мотивировало бы пользователей первого инстанта переходить на неё и привлекало бы новых пользователей к iCMS вообще. Все это должно только увеличивать совокупную прибыль авторов всеми нами любимой InstantCMS.

Кстати, к вопросу о "денег жалко"...
Там, в "деловом предложении", ключевая фраза – кто сколько может!
Поэтому этот пункт опроса – немножко провокационный.
Кому-то тыщи не жалко, а кто-то сотню "с кровью" оторвёт, но в таком деле из этих сотенок и тыщёнок может сложиться нормальная сумма, если заинтересованных пользователей не слишком мало.
А судя по этому сайту, этому форуму, а особенно – судя по вопросам, которые в блоге, где Автор выложил видео-туториал, таких нуждающихся в систематизации своих (не всегда твёрдых, скажем честно) знаний, очень много! Так лучше заплатить сколько не жалко, чем десятки часов тратить на то, что становится иногда понятно после двух-трёх прочтений пары страниц!
Вот поэтому я (обладатель не твёрдых знаний, стремящийся к системному охвату материала) и предлагаю:
– Братцы, давайте промотивируем автора документации на завершение уже начатой Прекрасной Работы!
Извините за излишние эмоции

Однако, её написание замерло "на самом интересном месте", причём, уже довольно давно.

В свете потребителя- замерло, но в свете разработчика — развивается постоянно и имеет тенденцию к улучшению и более вероятно что может быть… может быть..
1- определены базовые методы классов и параметры данных.
2- дальнейшее определения взаимосвяэей
3- возможно полное изменение кода

1- определены базовые методы классов и параметры данных.

oll, а можно с этого места поподробней!
Где определены?
Я как раз хотел спросить: есть ли где-то сводные таблицы переменных, классов, методов, которые можно было бы распечатать (или во вкладках держать первое время) и пользоваться, как кратким ёмким справочником?
Заранее спасибо!
P.S.
Я прекрасно вижу потенциал этой системы и поражён – какой скачок произошёл при переходе на 2.0!
Поэтому и волнуюсь, чтобы автор(ы) не забросили это дело, в поисках конкретных заказов (я уже купил тут кучу пока не нужных мне компонентов, чтобы хоть как-то поддержать именно бесплатную часть разработки). А документация к бесплатной части разработки – всегда, во всех проектах, делается "по остаточному принципу". Судя, по голосованию, есть надежда переломить эту тенденцию…

На что складываться? На рерайтеров?) Или вы думаете разработчик не видит задач?

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

Однако, её написание замерло "на самом интересном месте", причём, уже довольно давно.

oll, а можно с этого места поподробней! Где определены?

Определены как рабочие функции и аргументы, что непонятно?
Система для Вас в данный момент рабочая?
Временно определенные методы будут дорабатываться, далее будут измения кода, вот возможно в даном промежутке не стоит документировать временные позиции,
А разработчики R2 a pair FUZE всегда ответят на все Ваши вопросы касающиеся имеено той необходимости Ваших вопросов, с которыми у Вас есть проблемы!

Ну, что вы, oll, не буду я отвлекать людей по таким пустякам!
Почитал вопросы под видео-туториалами – я бы, на месте авторов, туда и носа не совал бы – мелкая бессистемная конкретика, типа, вот у вас на видео всё так быстро летает, я тоже так хочу, поподсказывайте мне, пожалуйста, на какие кнопки мне понажимать, чтобы тоже за вечер компонент у меня залетал, а за неделю – сайт крутой...
Для того внятная документация и нужна – чтобы в форумах обсуждать нюансы, а не "от Адама и Евы" спрашивать бесчисленных советов...
Видео, конечно, очень заводит на работу. Но потом выискивать там все эти сотни мелочей, среди нескольких часов речевого потока – это очень перректально. Тут и нужен, возможно, после видео, чёткий хорошо структурированный мануал – именно такой, какой там и лежит, но недоделанный!

Не могу согласиться и с проблемой "доработки" – на этих классах уже всё построено, уже после первых глав больше года прошло...
Возможно, тут ещё всю жизнь доработки будут, но для документации нужен чёткий костяк! А он уже очевидно сложился. Да и те статьи, что выложены, настолько чётко всё раскладывают по полкам, что диву даёшься – как программисты, порой, классно писать умеют!

И ещё раз уточню второй важный вопрос:
есть ли где-то некие таблицы, в которых перечислены штатные классы, методы и свойства системы с краткой функциональной характеристикой?

Aquarius,
Посмотри: sistem/core

Спасибо, joo a, это на самом деле (без иронии) отличный совет!
Потому что я довольно внимательно прошерстил все ветки исходников и многое понял. Но разве это исключает то, что начатый мануал должен быть закончен? Почему надо перректально дела делать?
Почему надо тысяче человек тратить сотни часов на некий интеллектуальный онанизм? Если можно одному, который глубже всех вник в данный вопрос, потратить десятки часов на нормальный мануал и миллионы человеко-часов будут сохранены для гораздо более полезных дел (у меня семь дочек и внучка – мне жалко обворовывать их, тратя время и внимание на всю эту приятную ерунду).

А чтобы приоритеты не перекашивались, нужен механизм влияния на решения тех, кто в ответе за тех, кого приручил (по выражению Экзюпери).
Таким механизмом может быть и простое голосование.
Но гораздо более "взвешенный" результат даёт голосование рублём. Однако, прямого такого механизма на этом сайте нет (вот бы где Билинг задействовать), поэтому я и начал эту ветку, в надежде на то, что и авторы проекта, и разработчики, использующие проект для своей работы или досуга, откликнутся…

Aquarius, вот вы грамотный специалист, умеющий читать исходный код, правильно я понял? Вам практически все стало ясно и понятно, так зачем в данный момент руководство разработчиков, если двойка по сути сама еще не закончена? Разработчику и так все понятно, а нам, юзерам, это руководство не нужно! Тратить время на мануалы сейчас, чтобы потом их переписывать? Как уже выше говорилось, сейчас важнее перевод премиум-компонентов под двойку, дальше уже можно и документацию писать. Еще бы я добавил, что описанные в мануале действия не совсем полно раскрывают свою суть. Я бы предложил R2 открыть возможность редактирования вики для других пользователей. Лично у меня было желание некоторые моменты в руководстве администратора дополнить.
По теме — мы тут уже скидывались с прицелом на ускорение процесса разработки двоечки, но работа шла обозначеными ранее темпами, и даже с задержкой — разработчики не готовы рисковать своей основной работой ради наших с вами хотелок. И даже если предположить, что разработчики уйдут с головой в проект, это не значит, что все будет быстро и так, как хочется нам. Во-первых, у разработчика одна голова (не факт, что думающая, как все пользователи), а во-вторых, 2 руки и максимум 24 часа в сутки с перерывами на отдых и прочие радости и обязанности жизни.

Единственное, чего хотелось бы — перестроения сайта сообщества и прием в команду разработчиков, учитывающих требования и рекомендации R2 при написании расширений под двойку.
Переделка сообществу нужна уже давно и как воздух. Первые шаги в этом направлении сделал Site-Stroi, будем надеяться, официальный сайт инстанта перейдет на аналогичную политику, но с упором на качество.

Да, и все равно, я бы скинулся :)
Вот дождусь шопа, скинусь! Дождусь обновленного офсайта — еще скинусь. Думаю, многие примут за честь поучаствовать финансово в переходе инстанта на новый уровень!
Даешь полноценную РУ-конкуренцию жумле и модэксу!

AndroS, есть специалисты, которым мануал не нужен (таких единицы и вряд ли они здесь "пасутся"), есть юзеры, которых пока объектная модель CMS не интересует (может никогда и не понадобится), но большинству тех, кто хочет взять Instant за основу, но дописать свои нестандартные (читай "слишком редкие, специфические") компоненты и виджеты, такой мануал нужен как воздух!
Законспектировал 2 части видео-туториала – часов 10 потратил. Да, теперь у меня и на бумаге есть кое-что, но этот титанический труд, во-первых, каждому придётся делать, а во-вторых, он ценен в виде цепочки действий и рассуждений – очень трудно из него извлекать мысли в проект другой структуры, да и справочные важные сведения размазаны словно каша по тарелке. А то и приходится снова лезть в видео – уточнять то, что в конспект не попало… Когда смотришь – дух захватывает, как там всё складно и быстро, а самому-то писать или переделывать – другие ощущения...

Но главный мой аргумент в том, что там уже начато дело – классно начато! И, надеюсь, для человека, владеющего вопросом в совершенстве, не слишком велик этот труд. А те, кому это адресовано, обязательно окупят эту работу более гибким использованием Инстанта, а это и новые проекты, и покупка платных компонентов, и такая вот, как я предлагаю (и делаю) посильная помощь разработчикам.

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

Aquarius, вы славно поработали. Предложите ваш конспект R2 для внесения в wiki — уже будет результат или опубликуйте на свое ресурсе или блоге. С кармой поможем.

Откройте видеоуроки, ну просто все разжевано!!! посмотрев, и делая вместе с автором создал компонент исключительно тот который мне требовался на двойку, заодно переменные подучил.