LINUX.ORG.RU
ФорумTalks

Большая проблема гиперактивных опенсорс-проектов


0

0

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

Например, в ExtJS все вот так вот печально.

Приятные встреченные мной исключения — это Django и Symfony. Но Symfony релизится соборным способом, и полноту доков они гарантируют на момент релиза. В принципе, это ожидаемо. Django вроде как поспевает за разработкой.

Худший из сценариев — это когда берется мануал по той версии библиотеки, которая была наиполнее документированной, а потом пропасть между версиями заполняется чейнджлогом, пробами и ошибками (ибо ничего другого нет, а то, что есть, лучше бы его не было, ибо мешает зело). Хуже него только тогда, когда пробелы надо заполнять логом из системы управления версиями.

★★★★★

например в linux kernel все так печально

antony986 ()

у django доки хороши до тех пор, пока ты не залез в его внутренности ))

antony986 ()

неделя проблем опенсорс-проектов на лоре?

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

mrMejik ()

Деточка, ты не видел документацию по проприетарщине... особенно из ниппонии. вот уж где траходром полный.

NuclearPhoenix ()
Ответ на: комментарий от NuclearPhoenix

Эт да. У меня до сих пор икота от страха, испытанного при просмотре SDK для фотошопа и того что называют его документацией.

tia ()

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

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

mrMejik ()
Ответ на: комментарий от tia

Зато по самому фотошопу нормальная документация. Мне кажется диким, что к примеру блендер идёт без документации.

Leron ★★ ()
Ответ на: комментарий от Leron

а разве по фотошопу доки пишет адобе? я так понял, что всякие шарашки в подвалах печатают книжки вроде «Фотошоп для электрочайников», «Как стать супердизайнером».

по гимпу видел пару неплохих руководств для начинающих по обработке фото. к сожалению, их найти не могу теперь %(

mrMejik ()

Угумс, у КДЕ и в тройке документация не всегда была первой свежести, а уж после переделывания всего и вся в четвёрке.. >_<

AX ★★★★★ ()
Ответ на: комментарий от mrMejik

Да, это нормальная практика постановлять мануал вместе с программой. Адоб ей следует. Не видел пока платной программы, особенно такой дорогой как фотошоп, к которой не шёл бы мануал где расписана каждая кнопочка - в этом отличие от «фотошоп для электрочайников». Как пример - http://www.3d-coat.com/download/

Leron ★★ ()

Re: Большая проблема гиперактивных опенсорс-проектов

При чем тут большое количество коммитов и доки? Доки идут в стабильную версию, а коммиты - в транк. Впрочем, github и bitbucket давно превратились в соц. сеть, где можно быть в курсе событий)

kost-bebix ★★ ()
Ответ на: комментарий от Leron

НУ так Блендер ставится из репозитариев, так что, запустил, посмотрел на него и понял «надо найти документацию!»

CyberTribe ★★ ()
Ответ на: комментарий от Leron

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

поэтому не могу судить по качеству док-ции у проприетарных/опенсорсных программ, но вроде как у больших проектов гном/гимп/етц тоже справка не хромает, проблема именно в мелком вроде бы софте/библиотеках, вот там опенсорс/проприетарщина наверное идут наравне

mrMejik ()
Ответ на: комментарий от mrMejik

> посмотреть хотя бы на вики арча или генту.

Да очень полезная вещь. Часто дока по генту помогала решить незнакомую проблему (в том числе и под другими unixами).

Так что, наверное, это правильный путь - открыть документацию для коммьюнити.

sign ()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.