Документация при создании сайта. Кто делал?

Я пытался вести документацию при создании сайта, но столкнулся с тем, что мне проще сверстать тему с нуля, чем объяснить и описать как это сделано.

Я веду блог для этого (в подписи), а неофициальные заметки-наброски здесь.

Я содидарен с Аней. То что более менее не стандартное записываю тут в форуме либо блоге. Когда пост смотрел думал он про другое немного. Извините за оффтоп, но.... Пишет (или писал) ли кто нибудь инструкцию по использованию админки для заказчика? Просто недавно вежливо попросили написать.

Ого! Можно сказать "моментальная реакция". Спасибо.

Аня, я тоже делаю заметки на сайте и бумаги много расходуется. Я наверное неточно выразился.
Интересуют не просто заметки или информация о модулях, а о том, что и как было сделано/настроено на данном конкретном случае.
Чтобы позже, когда придётся вносить изменения можно было быстро въехать в тему и исправить.

Писать полную инструкцию по админке для заказчика - гнилая работа.
А краткие описания того или иного модуля-раздела есть и так.

Какая еще нужна инструкция?

Вот модуль специальный http://drupal.org/project/sitedoc

Химический Али я это понимаю, но желание клиента как говорится закон. У меня одни пока такие славабогу. Так или иначе данный аспект присутствует на этапе жизненного цикла любого ПО.
VladSavitsky я думаю это полезно еще и по тому, что всегда можно показать заказчику накладные трудозатраты.
Аня у нас кладезь модулей :)

кладезь

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

Химический Али, спасибо. По русскому 3 :)
Roof я еще не написал. Но как напишу, то обязательно.

Пользуюсь www.projectpier.org для ведения проектов, все задачи и блог разработки всегда можно посмотреть, все материалы собраны в одном месте. И поддержку оказывать проще.

Player, спасибо.
И вот тут возникает мысль: а не пора ли написать мануал (хендбук, как хотите называйте) именно для клиентов, а не для разработчиков. С учетом специфики.
Player, я не против поучаствовать, хоть и тяжело мне эта писанина дается, но все-таки может полезно кому-нибудь будет.

Я думаю что часть для мануала можно будет взять из учебника «Drupal для пользователей» Но я его не смотрел еще.

Мысли про мануал для пользователей:

• Пользователи бывают разные (одни просто создают документы, а другие (редакторы) имеют дополнительные права на управление). Поэтому и инструкция должна быть разная для разных уровней. Вывод: нужно или делать доки для разных типовых ролей, или делать отдельно по разным модулям/функциям.
• Люди читать не любят - может лучше видео? На крайний случай - краткая памятка на 1 лист, чтобы можно было распечатать и обвешать все стены кабинета :-)
• Ещё отличный вариант - предлагать им купить книги про Друпал - сейчас они уже есть. Пусть сами выбирают и читают.
• Если же они хотят обучение - за доп. деньги.
• Если хотят инструкцию с подписью разработчика "На долгую память, с любовью Вася Пупкин" - опять же за очень дополнительные деньги. Это огромный кусок работы!

Про документирование проекта.
Лично меня интересует именно тонкости настройки сайта. Вдруг что-то не так работает на сайте (например, какой-то блок). А я не помню - толи Views выводит этот блок, толи я сам его написал (сниппет) - приходится открывать смотреть... Это долго. Вот я и задумался...

Sa_Bo_Nim,
собственно тема и возникла после ознакомления с модулем http://drupal.org/project/sitedoc
Отличный модуль и если не найду другого решения, то буду использовать его. Просто его разработчики указывают, что он может СИЛЬНО нагружать сервер, поэтому я стал искать простую и легкую альтернативу.

andypost@drupal.org, спасибо за ссылку. Буду смотреть сейчас же!

Не только пользователи бывают разными, сайты тоже как правило мало похожи друг на друга. Разные типы материалов, разные поля для каждого материала, разные модули, блоки и тд и тп. Кроме того сталкивался с такой ситуацией, что мануал со скриншотами от стандратной темы был не принят заказчиком, потому что это "не их сайт".
После этого стараюсь убеждать клиентов, что им не нужен мануал, что лучше 2 часа потратить на обучение и показать все на пальцах, на рабочем сайте.
End-user мануал - зло!

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

Видео это кстати хорошая идея.

Идея видео хорошая, но чем его писать?
Желательно во flash и бесплатной программой :)

Я никогда такого не делал - нужно спросить у тех, кто уже пробовал. Самому интересно.
Вот что я нашёл: Видеоблоггинг: создаем обучающие видео для своих блогов
Эта программа снимает экран (AVI), а звук с микрофона и сохраняет в Streaming Flash videos (SWFs).
Кстати, вот прямая ссылка на скачивание софта (но он под винду): http://camstudio.org/dev/
Или вот ещё: http://sourceforge.net/project/showfiles.php?group_id=131922

А нужно лектора снимать или экран?

Только нужно помнить что youtube и ему подобные такие форматы (SWF (Shockwave Video)) не принимают:

YouTube принимает широкий диапазон видеофайлов, полученных при помощи большинства видеокамер, цифровых фотоаппаратов и мобильных телефонов в форматах WMV, AVI, MOV и MPG. Если вы предполагаете, что текущий формат файла вашего видео не распознается YouTube, то можете добиться лучшего результата, преобразовав свой файл в видео MPEG4 со звуком MP3.
Поэтому нужна еще одна программа, которая сможет преобразовать SWF.

Wink записывает скринкасты и дает возможность вставлять пояснения итп. Просто записать видео с экрана (скрникаст) - istanbul или gtk-recordmydesktop. Правда, понятия не имею, как обстоит с таким софтом под виндами ;) В принципе, даже упомянутое может иметь версии под винды, да еще специфически виндового должно быть много.

gtk-recordmydesktop у меня в Мандриве есть - буду пробовать. Спасибо за подсказку.
istanbul тоже есть, но требует python для работы.
Больше у себя ничего не нашёл...
Буду смотреть эти 2 программы. Спасибо, Portnov.

gtk-recordmydesktop сохраняет в .ogg - это значит нужно будет позже его чем-то конвертировать.
istanbul работает быстрее, сохраняет в том же формате .ogg, но очень сильно сжимает (большая потеря качества).

Вот еще статья про это дело

По вашей ссылке нашёл в одном из комментариев:
Список софта для записи с экрана
Для линукса оказывается можно использовать:
VLC - using screen:// as media to play, stream or to save.

Нашёл уже готовое видео (но на английском) - остаётся только надеть прищепку на нос и сделать русский перевод:
http://mydrupal.com/drupal-beginner-videos-basics