?

Log in

No account? Create an account
Craftman

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

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

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

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

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

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

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

UPD. Сайт изменился. Я поправил ссылки в этом посте.

Comments

Очень интересно, как-нибудь погляжу обязательно.
Классная вещь. Жаль, мне никуда не пригодится (пока что).
Кстати, я вот как раз пользуюсь trac & svn. Заходишь в timeline - там список изменений. Так вот, при коммите мессагу можно оформить вики-форматтингом, и комментарий в траке к коммиту будет тогда "красиво" оформлен. ;)
сама возможность получить все в одном флаконе (да хоть в .chm) - очень давняя моя "хотелка". неплохая штука, возможно пригодится, спасибо!
Пожалуйста, пропиши кодировку страницам, а то у меня по-умолчанию знаки вопроса показываются.
Угу. Прописал. Проверь пожалуйста.
Работает. Спасибо!