Комментарии в блоге "Документация, курсы и все остальное..." на "Документация по седьмой версии"

Комментарии на "Документация по седьмой версии" от Роберт Басыров

Wed, 04 Mar 2009 15:56:28 +0300

Обновлен файл CHM Документации для пользователей.
Добавлены описания новых компонентов. В настоящее время встретятся две формы оформления страницы: старая и новая, не пугайтесь.

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

В связи с тем, что придется отвлекаться на написание документации по готовящемуся новому релизу Корпортала, решили выложить CHM "как есть", что бы немного облегчить участь тех, кто предпочитает CHM он-лайновой доке.

В течение месяца будет обновлен и CHM для разработчиков.

Комментарии на "Документация по седьмой версии" от Роберт Басыров

Wed, 23 Jul 2008 17:54:05 +0400

В общем понятно, спасибо. НЕ обещаю что будет реализовано скоро, но будем работать.

Комментарии на "Документация по седьмой версии" от Олег Волков

Wed, 23 Jul 2008 17:30:17 +0400

Я естественно говорю исходя из задач с которыми сталкиваюсь сам (редакция "Эксперт").

1. Частная документация по модулю "Реклама"

Информация о том как реализовать и предоставить рекламодателям все популярные рекламные возможности на интернет-проекте:
- растяжки на весь экран (600*90)
- статичные баннеры
- pop-up'ы

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

Модуль с очень большими возможностями, которые я думаю мало кто использует на 100%.

2. Частная документация по модулю "Статистика"

Здесь больше о возможностях анализа собственного сайта и анализа рекламных компаний.
Я помню Сергей Рыжиков делал презентацию в Питере этого модуля очень красочно, однако, на примере демо-сайта с нулевыми показателями.

Было бы интересно увидеть обзор возможностей, в частности видео-презентация - замечательная идея.

3. Большое количество know-how по модулю инфоблоков.

Не думаю что частная документация для пользователей нужна, а вот множество примеров - точно.

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

Комментарии на "Документация по седьмой версии" от Роберт Басыров

Wed, 23 Jul 2008 10:21:53 +0400

Частная документация по отдельным модулям и конкретным задачам стоит в планах и будет реализовываться. В этом плане крайне важна информация от пользователей о списке и приоритетах таких руководств. Определенное понятие о круге этих задач сложился, то это наше понимание. Вам-то какие в первую голову, какие во вторую голову нужны?
Для API прикрутим к документации возможность добавлять комментарии. ТУт будет для вас широкое поле деятельности.
Конкурс на лучшее know how - подумаем.

Комментарии на "Документация по седьмой версии" от Роберт Басыров

Wed, 23 Jul 2008 10:13:49 +0400

ТАк и происходит. Но есть моменты, где техписам просто делать нечего рядом с разработчиками. Описания функций, событий и прочего. Это вотчина разработчика, мы же можем только "облагородить" уже написанное.

Комментарии на "Документация по седьмой версии" от Олег Волков

Wed, 23 Jul 2008 01:06:36 +0400

Роберт, прошу прощенья

До этого читал сообщения о новых редакциях от Сергея Рыжикова, поэтому такое обращение в начале сообщения

Комментарии на "Документация по седьмой версии" от Олег Волков

Wed, 23 Jul 2008 00:58:59 +0400

Сергей, по поводу документации для пользователей:

1. Мастерклассы по отдельным модулям.

- например, о настройке и использовании модуля рекламы.

2. Know-how/cooking book (много маленьких заметок и удобных инструкций для настройки тех или иных вещей)

- например, классно сделали описание изменения дефолтной навигации
- сделайте маленькую инструкцию о том, как вывести "следующая новость -> " "<- предыдущая новость"

То есть обязательная документация это замечательно, замечательно и мануалы. Это нужно.

Как я понимаю конкурс на лучшие партнерские модули провалился?

А почему бы не сделать конкурс на лучшее know how по совершенствованию публичной части продукта?
Давать приз за лучшую подробную статью/инструкцию, - она не обязательно должна быть большой или сложной.

Результатом в идеале должен стать свой "магазин идей" как это реализовано на сайте individ.ru для клиентов компании.

Комментарии на "Документация по седьмой версии" от Александр Черкасов

Tue, 22 Jul 2008 20:53:17 +0400

====quote====
программистам проще написать 10 страниц кода, чем 10 строк осмысленного человеческого текста
=============
+1 ))) Сам программер
Наверно, в этом случае, желательно работать совместно работать программерам и документальщикам. imho

Комментарии на "Документация по седьмой версии" от Сергей

Tue, 22 Jul 2008 19:00:35 +0400

Полностью поддерживаю твое негодование

Комментарии на "Документация по седьмой версии" от Андрей Марадуда

Tue, 22 Jul 2008 18:01:58 +0400

API...