The OpenNET Project / Index page

[ новости /+++ | форум | теги | ]

Серьезность проблемы пренебрежения открытых проектов процессом документирования

20.04.2010 16:47

Джо Брокмейер (Joe "Zonker" Brockmeier), недавно покинувший пост лидера сообщества разработчиков openSUSE, опубликовал заметку в которой посетовал, что Google следовало бы провести наряду с "Summer of Code" инициативу "Summer of Documentation", в которой привлечь молодежь к процессу документирования кода, написанию качественных руководств, переводу на другие языки и улучшению дизайна пользовательского интерфейса. По мнению Джо на вопрос, чего не хватает открытому ПО, один из наиболее частых ответов - "документации".

  1. Главная ссылка к новости (http://ostatic.com/blog/wheres...)
Лицензия: CC BY 3.0
Короткая ссылка: https://opennet.ru/26303-opensource
Ключевые слова: opensource, documentation
При перепечатке указание ссылки на opennet.ru обязательно


Обсуждение (39) Ajax | 1 уровень | Линейный | +/- | Раскрыть всё | RSS
  • 1.1, Аноним (-), 17:04, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • –2 +/
    Как будто к проприетарщине больше документации...
     
     
  • 2.4, name (??), 17:22, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    ну вот к win32 GDI, к примеру, её _как минимум_ на порядок больше, чем к иксам
     
     
  • 3.16, User294 (ok), 21:28, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    Осталось только найти мазохистов которые будут под гольные иксы программить :D
     
     
  • 4.41, Аноним (-), 19:52, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    Под иксы документации - пяток толстеньких книжечек от O'Reilly плюс подробные описания ключевых библиотек и протоколов X11 в комплекте дистрибутива (объемистые такие pdf'ки).

    Вы мне лучше покажите мазохистов, которые в 2010 году будут программить под Win32 GDI, без MFC и прочих дотнетов.

     
  • 2.11, anonymous vulgaris (?), 21:23, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • –1 +/
    >Как будто к проприетарщине больше документации...

    хелпы там нормальные


     
     
  • 3.13, Трухин Юрий Владимирович (?), 21:26, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • –3 +/
    Речь не о хелпах, а о документировании кода. Да, в опенсорсе бывает его совсем нет и это очень ужастно
     
     
  • 4.18, anonymous vulgaris (?), 21:35, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Речь не о хелпах, а о документировании кода. Да, в опенсорсе бывает
    >его совсем нет и это очень ужастно

    речь в новости абсолютно обо всем включая translators, user interface designers, artists,
    а самое слабое место это обычно хелпы, потому что - TONS of documentation that many people simply CAN'T slog through.


     
     
  • 5.28, Трухин Юрий Владимирович (?), 09:25, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >а самое слабое место это обычно хелпы, потому что - TONS of
    >documentation that many people simply CAN'T slog through.

    вы не рвзработчик на сколько я понимаю... иначе вряд ли такое бы написали. Help можно написать, а вот использовать более-менее сложную библиотеку без комментированного кода нереально. Если вы конечно не обладаете даром телепатии.


     
     
  • 6.30, Вова (?), 09:56, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >>а самое слабое место это обычно хелпы, потому что - TONS of
    >>documentation that many people simply CAN'T slog through.
    >
    >вы не рвзработчик на сколько я понимаю... иначе вряд ли такое бы
    >написали. Help можно написать, а вот использовать более-менее сложную библиотеку без
    >комментированного кода нереально. Если вы конечно не обладаете даром телепатии.

    всё правильно, + примеры использования, тоже адски важны.

     
  • 4.25, Ян Злобин (ok), 03:44, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Речь не о хелпах, а о документировании кода. Да, в опенсорсе бывает его совсем нет и это очень ужастно

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

     
     
  • 5.26, Feadot (ok), 08:57, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • –1 +/
    >Зачастую можно обходиться и без подробной документации, ибо есть исходники. Особенно, если код писан по стандартам GNU - читать его одно удовольствие.

    Сплю и вижу домохозяйку, которая читает исходники дабы понять как работает программа...
    По нажатию F1, не хэлп, а сразу исходник программы открывает!

     
     
  • 6.33, Ян Злобин (ok), 10:23, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Сплю и вижу домохозяйку, которая читает исходники дабы понять как работает программа...

    При чем здесь домохозяйка-то?  Речь зашла об исходниках, а это явно не для домохозяек. :-)

     
  • 5.29, Трухин Юрий Владимирович (?), 09:26, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • –1 +/
    >>Речь не о хелпах, а о документировании кода. Да, в опенсорсе бывает его совсем нет и это очень ужастно
    >
    >Зачастую можно обходиться и без подробной документации, ибо есть исходники. Особенно, если
    >код писан по стандартам GNU - читать его одно удовольствие.

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

     
     
  • 6.32, Ян Злобин (ok), 10:22, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    >и много сорцов ты прочитал и понял без телепатии? Неужели в ваших
    >гнутых стандартах нет требования комментировать код... я очень удивлюсь если так

    Да немало.  И регулярно читаю.  Где-то есть комментарии, где-то нету.  Когда код хорошо оформлен обычно и без комментариев все понятно.

    Например, что делает функция gtk_tree_view_get_selection легко понятно из без телепатии. :-)


     
     
  • 7.39, vayerx (ok), 17:10, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    реализацию математики почитайте
     
  • 5.44, Веслый мясник (?), 01:37, 22/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    Сплю и вижу человека, который юзает (к примеру) OpenSSL, руководствуясь исходниками. Смешно, ей-богу...
     
  • 5.45, неизвестный (?), 08:29, 22/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    полность согласен
     

  • 1.2, А (??), 17:11, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • –2 +/
    Большинство кода дают большие компании и в отсутствии док есть логика. Код открыт и бесплатен, кто ниасилил прочитать код и разобраться как работает платит за поддержку. Пока красноглазые приверженцы меряются крутизной дистров умные дядьки деньги зарабатывают.
     
     
  • 2.5, name (??), 17:25, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +2 +/
    >кто ниасилил прочитать код и разобраться как работает

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


     
  • 2.7, аноним (?), 17:58, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +3 +/
    А автор пробовал разрабатывать что-нибудь сам?
     

  • 1.3, croster (ok), 17:16, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    Есть и проекты с хорошей документацией. Пример - PostgreSQL, там документация на 2000 страниц в pdf формате.
     
     
  • 2.6, Твистер (?), 17:40, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    На sendmail вон более 1200 страниц описания
    и что кто-то активно пользует?
     
  • 2.8, Аноним (-), 18:57, 20/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    согласен, отличная документация у mediawiki а худщая у zend framework
     

  • 1.12, Belov Sergey (ok), 21:23, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    У многих проектов с документацией проблемы. Особенно с локализованной. Справка к GIMP переведена лишь частично.
    Из-за этого у нас внедрение в учебный процесс тормозится.
     
  • 1.20, rm_ (ok), 21:52, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +2 +/
    Переводы вечно устаревшие и неактуальные, в реальности никто их не будет поддерживать в актуальном состоянии в свободных проектах, как бы этого ни хотелось г-ну Джо Брокмейеру. Поэтому хотите пользоваться компьютером - извольте знать хотя бы технический английский.
     
  • 1.21, амонинус (?), 22:22, 20/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    Да, к сожалению. Многие лидеры проектов еще не поняли, что даже если код компилируется не на компьютере, а в голове, и не с Си, а с английского, он не менее важен, чем тот, который в компьютере, и должен, блин, быть частью проекта, а не "сопровождением". Особенно когда проект открытый.
     
     
  • 2.31, Вова (?), 10:00, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    >Да, к сожалению. Многие лидеры проектов еще не поняли, что даже если
    >код компилируется не на компьютере, а в голове, и не с
    >Си, а с английского, он не менее важен, чем тот, который
    >в компьютере, и должен, блин, быть частью проекта, а не "сопровождением".
    >Особенно когда проект открытый.

    Заурядный программист пишет код, понятный компилятору, хороший - код, понятный другому программисту.

     
     
  • 3.36, Aleksey (??), 14:02, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +1 +/
    А очень хороший еще и документацию к коду.
     
     
  • 4.37, Вова (?), 14:43, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    всё так, локальные викисы и сам пишу, и в других приветствую.
     

  • 1.24, XoRe (ok), 00:47, 21/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    Я так понимаю, открытые исходники недостаточно документированы по сравнению с закрытыми?
    Ну, давайте посмотрим на закрытые исходники, поучимся у них документированию)
    А где закрытые исходники?
    Нету.
    Т.е. Брокмейер сетует только по поводу того, на что можно посмотреть.
    Посмотрел бы он на документированность закрытого кода...)

    А документация к программе...
    Мистеру Брокмейеру стоит указать на команду man, которая дает возможность почитать не только документацию к программам, но даже к функциям языков (man malloc).

    В остальном я бы сказал, что на документацию всегда можно найти время.
    Если один человек будет заниматься только документацией, он сможет немало написать)
    Нужно просто исходить из позиции "это нужно сделать".

     
     
  • 2.46, anonymous (??), 18:08, 23/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    Документированный код — это не обязательно комментарии в исходниках. Новость перечитайте.
     
     
  • 3.47, XoRe (ok), 22:33, 23/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Документированный код — это не обязательно комментарии в исходниках. Новость перечитайте.

    Ну, если вы про man'ы, то с этим лучше, чем во многих проприетарных программах.
    А перевод на другие языки страдает, как у опенсурса, так и у клозедсурса.
    Не могу сказать, у кого страдает меньше.
    Если только разделить проекты по крупности и сравнивать в своей весовой категории.

     
     
  • 4.48, anonymous (??), 11:00, 24/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Ну, если вы про man'ы, то с этим лучше, чем во многих
    >проприетарных программах.
    >А перевод на другие языки страдает, как у опенсурса, так и у
    >клозедсурса.

    Перевод вопрос отдельный, в новости тоже разделено. А маны это только часть документации:

    $ man openoffice
    No manual entry for openoffice

    $ man firefox
    (сами оцените информативность;)

    и т.д. Для гуевого софта нужны обычные хелпы, а их часто или нет, или недостаточно наполнены, или не локализованы, или и то, и другое.

     

  • 1.27, Аноним (-), 09:17, 21/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +/
    "Серьезность проблемы пренебрежения открытых проектов процессом документирования"

    забористо

     
  • 1.35, Proger (ok), 12:02, 21/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • –2 +/
    А причём тут вообще "пренебрежение"? Трольвадс же сказал: "for fun", а какой фан писать доки?!? Каждый мнит себя кульхацкером и пишет код не для того, чтобы его потом скурпулёзно вылизывать и документировать - добьются компиляции, запустят перделку - всё, фан получен, сорсы - в массы! :) Или я ошибаюсь?

    А по мне не в доках дело, а в инструментах - чем примитивнее язык (С/С++), тем сложнее докапываться до логики (хотя она КАК БЫ очевидна). Это как с часами - вроде бы все колёсики на виду, но ни черта непонятно! :)) Так что надо двигаться в сторону C#/D, там хоть поменьше кодомусора.

    Ну и ещё момент: многие библебатеки написаны чуть ли не на заре линупса, некоторые - свежие, но опять являются чьим-то "портoм", в результате этот тухлокод поддерживается годами, совместимости ради. Перепроектировать этот хлам никому не интересно (а коммерч. компаниям и не выгодно), так что мегабайты обросших библиотек кочуют из дистра в дистр, затрудняя и компиляцию, и переносимость и даже улучшение. Либа более, чем в 500Кб кода - уже не поддающийся осмыслению монстр, так что даже доки тут не панацея - "вся проблема в головах".

     
     
  • 2.38, Ян Злобин (ok), 16:29, 21/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    >Так что надо двигаться в сторону C#/D, там хоть поменьше кодомусора.

    Глупости все это.  Если привык оформлять код как придется, то на любом языке получится мусор.

     

  • 1.40, eugeni (?), 18:33, 21/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • –1 +/
    Я "домохозяйка" и я хочу владеть документацией на родном языке.
    Я хочу настраивать свою систему как хочу.Я не хочу болтаться по
    идиотским форумам ,видя ,идиотские советы "учи американски".
    Не хочу долбитсься с Google-переводчиком.
    И я готов пожертвовать деньги для хорошего перевода.
     
  • 1.42, Аноним (-), 00:00, 22/04/2010 [ответить] [﹢﹢﹢] [ · · · ]  
  • +1 +/
    не вопрос. 200$ за 40 тыщ знаков, предоплата 50%. Да, и заказчик должен быть на Украине или в США. Устраивает?
     
     
  • 2.43, Аноним (-), 00:05, 22/04/2010 [^] [^^] [^^^] [ответить]  
  • +/
    сорри, про минимальный объем забыл добавить. 5 х 40 000 тыс. зн.
     

     Добавить комментарий
    Имя:
    E-Mail:
    Текст:



    Партнёры:
    PostgresPro
    Inferno Solutions
    Hosting by Hoster.ru
    Хостинг:

    Закладки на сайте
    Проследить за страницей
    Created 1996-2024 by Maxim Chirkov
    Добавить, Поддержать, Вебмастеру