Boroda aka Hamster (fantaseour) wrote,
Boroda aka Hamster
fantaseour

Bulldoc. Что-то про дукументацию

Написал скрипт на похапе. Делюсь.

При разработке программ мы обычно храним код в системе контроля версий (например svn). Было бы удобно хранить описания или рабочие записки в виде текстовых файлов в том же репозитории, что и код. В таком случае мы всегда сможем иметь документацию, относящуюся к разным веткам и версиям нашего проекта. Именно это и было поводом написать Bulldoc.

Многие программы и системы имеют на своих сайтах актуальную документацию, однако ее нельзя скачать к себе на локальный компьютер в сколь либо удобном виде. Сюда же относятся и wiki-системы, которые удобно быстро поставить, но неудобно архивировать или раздавать в виде скачиваемого файла. Желание дать возможность пользователям скачивать документацию в удобном виде — статичном многостраничном html, html-все-в-одном файле, chm, а также дать возможность оставлять комментарии было вторым поводом написать Bulldoc.

Многие программисты ведут блоги. В блогах мы пишем много разного — от коротких сообщений, вроде «Как хочется пива» до статей в нескольких частях с прологом и эпилогом. Стараемся поддерживать рубрикацию наших записей с помощью тегов. Блог хорош тем, что туда можно выложить интересную мысль, которая еще не оформилась в виде полноценной статьи. Однако часто хочется объединить несколько постов в один, когда мысль оформится. Страшно подумать, но когда-нибудь из нашего блога могла бы получиться самая настоящая книжка. Эта мечта была третьим поводом написать Bulldoc.

Что получилось, можно посмотреть тут: http://bulldoc.ru/doc/introduction.html
Скачать, тут: http://bulldoc.ru/download.html

Комментарии будут с благодарностью приняты. Заранее спасибо.

UPD. Сайт изменился. Я поправил ссылки в этом посте.
Tags: development, php
Subscribe

  • (no subject)

    Я очень люблю конференции. Они зажигают в разработчике свечечку, которую он потом бережно несет в себе через весь год! Когда-то давно, я с завистью…

  • wordpress: php -> nodejs

    Хипстеры захватывают мир :) Не очень понятно, как этот переход отразится, на людях, которые ставят этот вордпресс на любой копеечный хостинг с…

  • Продолжаем разговор/java, linux, fonts

    OpenJDK считается таким пакетом, который первым делом надо заменить на нормальную Ораклиную Джаву Но в случаее с IntellJ Idea & WebStrom и т.д.…

  • Post a new comment

    Error

    default userpic

    Your reply will be screened

    When you submit the form an invisible reCAPTCHA check will be performed.
    You must follow the Privacy Policy and Google Terms of use.
  • 6 comments