Прямой эфир

  • avatar
  • taliano
  • 10 августа 2011, 20:44
  • #
  • +1
Лучшая документация к open source программе — её код.
Поскольку я пользуюсь gcc, то являюсь его пользователем, и читал документацию. При этом мне не нужны сторонние источники сведений о пользовании gcc.
  • avatar
  • LRN
  • 10 августа 2011, 19:26
  • #
  • 0
А не являешься ли ты, случайно, конечным пользователем gcc? Если да — читал ли ты его документацию от начала и до конца? Если нет, то не собираешься ли ты стать конечным пользователем gcc?
Я конечный пользователь многих программ и читаю документацию от начала до конца :) И напротив, книг на ИТ-тематику я не люблю — они устаревшие, они многословные. Всё, что нужно для работы с программой, должно быть заключено в документацию. Поэтому и важна такая документация, которую можно читать как хорошую книгу.
Когда документация написана сухим ИТ-канцеляритом — её не хочется читать. Освоение функций сложной программы зависит напрямую от толковости документации, потому что, как правило, только документация современна текущей версии программы.
Видео кратко посмотрел — не имеет для меня пользы :)
  • avatar
  • LRN
  • 10 августа 2011, 18:13
  • #
  • +2
По-моему, понимание вопроса несколько странное.
«Скучная» — эпитет к документации не применимый. Документация может либо быть, либо не быть. Или быть неполной. Или быть устаревшей.
«Скучным» может быть туториал (т.е. учебник), который надо именно прочитать от начала до конца, чтобы научиться пользоваться программой и познать основные концепции её использования, которые позволят в дальнейшем использовать её «на ощупь» (то есть ты примерно представляешь, что и где искать, и просто исследуешь возможности по мере появления потребностей).
К документации обращаются за конкретными вопросами (когда не получается найти нужную рукоятку), читают только релевантные главы (пользуются оглавлением или полнотекстовым поиском). В документации ценятся точность и полнота. Доступность или недоступность для понимания — это скорее вопрос предметной области (хотя, корявое изложение тоже мешает). Но «живость слога» и «нескучность» тут вообще не в тему.

Кстати, это мне напомнило о недавно просмотренной презентации про gamification (была такая на Google Tech Talks; собственно, и позднее они были, но он-лайн не все можно посмотреть). Учись делать туториалы у создателей компьютерных игр.
Специально обученные люди тоже пишут нудную документацию. Хорошую документацию может написать только энтузиаст проекта, к коему документация относится, хорошо этот проект знающий и обладающий вдобавок живым слогом. Мне нравится документация Cinelerra, Reaper, в своё время была хорошая документация к Mplayer (когда разработчики с Джо Барром ругались). К играм вроде Baldur's Gate — тоже классная.
По-моему, документация — это что-то типа ДСП. Конечный пользователь ее все равно читать не будет. Документация — это сырье, из которого другие специально обученные люди делают что-то типа "* для чайников" :)
  • avatar
  • fog
  • 10 августа 2011, 16:16
  • #
  • 0
Мне кажется, что главная проблема документации к СПО в том, что её, зачастую, нет. :-) Не в том смысле, что нет совсем, а в том, что есть но старая, или есть, но не полная или есть, но написана так, что все-рано ничего не понятно. А скучность — это просто частный случай из этого списка.

Собственно, к проприетарному ПО документацию пишут специально обученные для этого люди. Если проект открытый и «на энтузиазме», то документацию приходится писать самим программистам. А какое главное свойство программиста? Правильно, лень. Поэтому разработчики придумывают разные системы по генерации документации, а как следствие, вся документация скучная и сухая. :-(
Отличная статья!
  • avatar
  • afoninsb
  • 10 августа 2011, 14:22
  • #
  • +1
а ученикам абсолютно все равно. Только одна семиклассница месяца через 3 сказала: «Что-то виндовс какой-то странный» ))
для первого раза и так не плохо получилось )) А это естественно при работающем сервере бегать по компьютерам не очень эффективно ))
  • avatar
  • Vascom
  • 10 августа 2011, 14:16
  • #
  • 0
Кстати, копирование скрипта на ученические компы и его запуск можно было сделать прямо с учительского компьютера по сети.

В целом очень рад за вас. Интересно как к этому отнеслись ученики?
пожалуйста! если что, обращайтесь
  • avatar
  • ooops
  • 10 августа 2011, 14:12
  • #
  • 0
Спасибо за статью. Сам работает в образовательном учреждении и давно подумывал о установке LInux на машины учеников
Да, по крайней мере фон совершенно не в кассу.
Как по мне, так в существующих средствах юзабилити получше чем на скриншотах, выглядит как сайт с далеких 90-х. Чем, к примеру, Тимбокс хуже? Там и юзабилити на уровне, и понтно все. Вот мне стразу не понятно что за потоки.

Для таких целей можно использовать и tenderapp.com/ — отличнеое приложение. Понятно желание сделать свой полезный продукт, но если предлагать его другим, нужно сделать его еще и привлекательным и удобным.
средства общения созданы для разработчиков!
Обычному пользователю, там нет место так как там все запутано
  • avatar
  • Vascom
  • 10 августа 2011, 10:44
  • #
  • 0
Ну так сервисы хранения репозитория тоже предоставляют средства общения и багтрекинга.