Качество документации.

Обсуждение документации. Переводы Cookbook и авторские рецепты.
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Качество документации.

Сообщение Aver »

Создается впечатление, что документацию писали (имею в виду русскоязычную) исключительно для тех кто уже знает фреймвек. У меня достаточно большой стаж php, но с фреймвеками работать не доводилось. Из глядя на эту документацию создается впечатление что не стоило и начинать. Понять струтуру я не могу. Например - http://www.yiiframework.com/doc/guide/ru/database.ar,
Для работы AR требуется подключение к базе данных. По умолчанию, предполагается, что компонент приложения db предоставляет необходимый экземпляр класса CDbConnection, который отвечает за подключение к базе. Ниже приведен пример конфигурации приложения:
Конфинурация - это хорошо, но где пример компонента DB ? Я полез искать в готовых примерах, так там вообще экземпляры класса CDbConnection не создаются.
И в таком стиле изложена вся документация. Говорят А, после чего переходят к А следующего пункта. Тот кто уже знает что и как там работает, конечно не задумывается уже об основах, но разобраться с нуля - очень сложно.
Опять же я понимаю, что это перевод родной документации. Но при таком ее качестве, гугль транслейт даст изущающему абсолютно то же количество данных по текущему вопросу.
Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Качество документации.

Сообщение timlar »

Довольно странно. У меня стаж работы с php очень маленький и тем не менее, я разобрался со структурой и успел полюбить этот фреймворк. Хотя по началу у меня были такие же мысли :) Даже темы здесь на форуме создавал по поводу "не доделанной" документации. На самом деле, ресскоязычная документация, это всего лишь перевод англоязычной, с небольшими доработками.

Создавать экземпляр класса CDbConnection не нужно. Его настройки описываются в конфигурации, а далее в приложении просто используются классы для работы с AR. Рекомендую для начала почитать Создание блога с использованием Yii и параллельно смотреть пример готового блога, который находится в архиве с фреймворком в папке demos.
Twitter: @timlar_ua
Аватара пользователя
samdark
Администратор
Сообщения: 9489
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Качество документации.

Сообщение samdark »

Aver
Задавайте вопросы, поможем. Ну и если будут конкретные предложения, как радикально улучшить документацию — высказывайте.
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

Собственно предложение есть. Написать пример с нуля. Безл всяких генераторов кода и охватывающий всю структуру. Пошагово. А то я ,например, не сразу понял, что компонент может вызываться до контроллера (к тому моменту как я дошел до компонентов, в голове на месте схемы работы фреймвека осталось мутное пятно). И таких моментов много. Когда разберусь с фреймвеком, попробую написать, но боюсь это будет не скоро.
В общем и целом из примра создания блога удалось вытащить немного. Закончилось тем что я взял пример helloworld и начал пошагово туда добавлять сомпоненты, фильтры, модели и т.д.
Еще есть вопрос, планируется ли перевод api, и если планируется то когда ? А то там так много интересных класов, но разбираться с ними на инглише (для меня) чистое мучение.
Аватара пользователя
slavcodev
Сообщения: 3134
Зарегистрирован: 2009.04.02, 21:42
Откуда: Valencia
Контактная информация:

Re: Качество документации.

Сообщение slavcodev »

Aver писал(а):Еще есть вопрос, планируется ли перевод api, и если планируется то когда ? А то там так много интересных класов, но разбираться с ними на инглише (для меня) чистое мучение.
Это вопрос на форуме поднимался, пришли к выводу, как минимум три причины этого не делать
- переводить очень много
- фреймворк молодой, не кому переводить
- пока что-то переводиться, АПИ меняется
Жду Yii 3!
Аватара пользователя
kosenka
Сообщения: 677
Зарегистрирован: 2009.09.26, 12:41
Откуда: москва
Контактная информация:

Re: Качество документации.

Сообщение kosenka »

Aver писал(а):Собственно предложение есть. Написать пример с нуля. Безл всяких генераторов кода и охватывающий всю структуру. Пошагово.
вот, примеры http://dbhelp.ru/category/yii-lessons/
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

kosenka писал(а):
Aver писал(а):Собственно предложение есть. Написать пример с нуля. Безл всяких генераторов кода и охватывающий всю структуру. Пошагово.
вот, примеры http://dbhelp.ru/category/yii-lessons/
Находил я этот блог. Совершенно не впечатло.
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

mc-bear писал(а):
Aver писал(а):Еще есть вопрос, планируется ли перевод api, и если планируется то когда ? А то там так много интересных класов, но разбираться с ними на инглише (для меня) чистое мучение.
Это вопрос на форуме поднимался, пришли к выводу, как минимум три причины этого не делать
- переводить очень много
- фреймворк молодой, не кому переводить
- пока что-то переводиться, АПИ меняется
Хотя бы общий обзор классов для начала. По небольшому абзацу, что бы знать что вот это похоже мне надо, пойду покапаюсь в инглише. Потом потихоньку описание методов.
Тут не поспоришь, да и сказать по этому поводу нечего. Количество переводчиков которые могли бы этим заняться я не знаю.
Апи будет менятся всегда.
Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Качество документации.

Сообщение timlar »

Aver писал(а):
kosenka писал(а):
Aver писал(а):Собственно предложение есть. Написать пример с нуля. Безл всяких генераторов кода и охватывающий всю структуру. Пошагово.
вот, примеры http://dbhelp.ru/category/yii-lessons/
Находил я этот блог. Совершенно не впечатло.
Как ты мог? Ты обидел нашего Оззи :)
Twitter: @timlar_ua
Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Качество документации.

Сообщение timlar »

Кстати, вот здесь еще цикл статей на тему "Создаем игровой сайт с нуля" :) http://www.simplecoding.org/category/yii
Twitter: @timlar_ua
Аватара пользователя
slavcodev
Сообщения: 3134
Зарегистрирован: 2009.04.02, 21:42
Откуда: Valencia
Контактная информация:

Re: Качество документации.

Сообщение slavcodev »

Aver, а ты случаем не с CodeIgniter'a на Йии переходишь? :)
Жду Yii 3!
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

Timlar писал(а):Кстати, вот здесь еще цикл статей на тему "Создаем игровой сайт с нуля" :) http://www.simplecoding.org/category/yii
Этого не видел, посмотрю, спасибо.
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

mc-bear писал(а):Aver, а ты случаем не с CodeIgniter'a на Йии переходишь? :)
Нет. До этого с PHP фреймвеками не работал совсем. Впрочем и сейчас склоняюсь его использовать только для админок. Там как правило работа ниболее муторная, и в тоже время админки в связи с малым количество к ней обращений не критична с нагрузкой. Я 1-ое что сделал это сравнил написаный мно кусок кода по выводу древовидной структуры, и аналогичный с выводом через yii. Несмотря на то что в описнии написано что он подключает только используемые классы, разница в скорости около трехкратной. А уж демо блог, тот на локалке вообще секунду php обрабатывает. Правда тестинг проводился на слабом компе(цилер 1.7) но тем не менее... секунда.Не видел таких цифр с последнего использования php-nuke.
Последний раз редактировалось Aver 2010.04.22, 16:07, всего редактировалось 1 раз.
Аватара пользователя
samdark
Администратор
Сообщения: 9489
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Качество документации.

Сообщение samdark »

API переводить пока планов нет. Основную документацию уже довольно длительное время перевожу я один. API поддерживать в актуальном состоянии не осилю.

По некоторым интересным классам есть рецепты. По всем и сразу написать пока не выходит.
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

Sam Dark писал(а):API переводить пока планов нет. Основную документацию уже довольно длительное время перевожу я один. API поддерживать в актуальном состоянии не осилю.

По некоторым интересным классам есть рецепты. По всем и сразу написать пока не выходит.
Респект. Я бы поленился. Объем работы большой.
По классам, это наверно те которые есть в документации. Еще не разбирал, только глянул по авторизации.
Аватара пользователя
slavcodev
Сообщения: 3134
Зарегистрирован: 2009.04.02, 21:42
Откуда: Valencia
Контактная информация:

Re: Качество документации.

Сообщение slavcodev »

Aver писал(а):А уж демо блог, тот на локалке вообще секунду php обрабатывает.
Шок :o , у меня на локалке проект в разработке, вот примерно замеры страницы, как видно далеко до секунды.

Код: Выделить всё

[  Yii ver: 1.1.2-dev  ] 
[  Memory: 6508.02Kb  ] 
[  Time: 0.266  ] 
[  DB Query: 16  ] 
16:23:14.599087    trace    system.CModule    Loading "log" application component
16:23:14.603018    trace    system.CModule    Loading "request" application component
16:23:14.604741    trace    system.CModule    Loading "urlManager" application component
16:23:14.617528    trace    system.CModule    Loading "db" application component
16:23:14.635926    trace    system.CModule    Loading "assetManager" application component
16:23:14.648313    trace    system.CModule    Loading "clientScript" application component
16:23:14.749666    trace    system.CModule    Loading "messages" application component
16:23:14.775999    trace    system.CModule    Loading "coreMessages" application component
16:23:14.792392    trace    system.CModule    Loading "user" application component
16:23:14.794131    trace    system.CModule    Loading "session" application component
Жду Yii 3!
Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Качество документации.

Сообщение timlar »

Писать на чистом PHP, а для админок использовать фреймворк, это то же самое, что имея в гараже машину, ходить пешком, а когда поджимает время - заказывать такси класса люкс :)
Twitter: @timlar_ua
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

Скорость зависит от железа. Я писал выше что железо как раз слабое. К тому же я писал конкретно про демо-блог. По поводу сравнения с такси класса люкс, тоже не уверен. Если переходить на такие ассоциации, то больше напоминает междугородний автобус. Большой, комфортный, но довольно таки неторопливый.
Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Качество документации.

Сообщение timlar »

Судить о скорость по демо приложению как минимум глупо... ИМХО... Судить стоит тогда, когда приложение написано, оптимизированы запросы, включен и настроен кеш и т.д. :)
Twitter: @timlar_ua
Аватара пользователя
Aver
Сообщения: 66
Зарегистрирован: 2010.04.22, 02:44

Re: Качество документации.

Сообщение Aver »

Вот поэтому я и говорю, что посмотрев на скорость демо приложения меня одолели сомнения и я написал кусок кода под yii аналогичный по функциональности существующему у меня и написаному на чистом php. Как я и говорил разница в скорости составила трехкратную. При чем в моем коде еще присутствовала аутентификация в yii я ее не делал.
Ответить