metaclass: (Default)
[personal profile] metaclass
Долго выбирал, в чем делать документацию, посмотрел всякие вики, докбуки и прочее. В итоге, по совету умудренных жизнью гуру, посмотрел LaTeX. Благо, под рукой наконец-то имеется линукс, где весь этот трэш ставится apt-get, а не поиском в гугле сайтов "LaTeX for windows, free троян в нагрузку, мокрые письки, скачать бесплатно".

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

Теперь осталось себя заставить не только код писать, но еще и писать в документации, зачем, как и почему я его пишу.

Date: 2009-12-18 08:35 pm (UTC)
From: [identity profile] vadim-i-z.livejournal.com
Зачем искать?
http://www.miktex.org/

Date: 2009-12-18 08:41 pm (UTC)
From: [identity profile] metaclass.livejournal.com
В прошлый раз у меня с ним чо-то ничего не вышло.
Или, скорее всего, меня отвлекли какой-нибудь "срочной нужно вчера" работой и я не докопался до конца.

Date: 2009-12-18 08:42 pm (UTC)
From: [identity profile] freiksenet.livejournal.com
Со всей любовью к латеху - почему не texinfo? Он ИМХО более пригоден к документации кода.

Date: 2009-12-18 10:07 pm (UTC)
From: [identity profile] metaclass.livejournal.com
Не знаю, почему. Но смотреть уже не буду - у меня мозг просто лопнет, если я еще что-нибудь новое за эту неделю узнаю :)

Date: 2009-12-18 10:22 pm (UTC)
From: [identity profile] permea-kra.livejournal.com
Ребе, пишите на хаскеле. Там можно код с доками на техе мешать ....

Date: 2009-12-18 10:50 pm (UTC)
From: [identity profile] metaclass.livejournal.com
У меня пока схема базы данных и описание "почему именно такая схема".
Хотя мысль описать схему на хаскеле и написать несколько преттипринтеров в sql, в документацию и в исходный код у меня была :)

Date: 2009-12-18 11:14 pm (UTC)
From: [identity profile] x-a-e-p.livejournal.com
Он, видимо, про literate haskell

Date: 2009-12-19 11:06 am (UTC)
From: [identity profile] migmit.vox.com (from livejournal.com)
С доками на LaTeX.

Date: 2009-12-19 04:38 am (UTC)
From: [identity profile] theiced.livejournal.com
да да ;)
и для вас висйоленькая смирительная рубашка найдётся.

Date: 2009-12-19 06:23 am (UTC)
From: [identity profile] theiced.livejournal.com
а вообще - ша набегут авторы деревня-говноинфо и будут рассказывать что всё реальные деревенские поцоны доки пишут в ворде 2020.

Date: 2009-12-19 09:30 am (UTC)
From: [identity profile] metaclass.livejournal.com
Я бы писал в ворде. Но он даже в последних своих ипостасях с системами контроля версий не совместим, а внутренние средства отслеживания изменений в нем убогие.

Date: 2009-12-19 10:52 am (UTC)
From: [identity profile] aamonster.livejournal.com
Как - не совместим? Если в SVN аж есть скрипты для человеческого показа diff'ов. (впрочем, насколько прилично это работает - не знаю, не пробовал... но и для TeX тоже не знаю - по хорошему ведь diff нужно смотреть не только для исходника)

Date: 2009-12-19 10:54 am (UTC)
From: [identity profile] metaclass.livejournal.com
Не, с вордом я не уверен в кошерности. Я думаю, что лучше разобраться с латехом, чем копаться в микрософтовской шизе, которую они еще десять раз поменяют.

Date: 2009-12-19 12:30 pm (UTC)
From: [identity profile] vp.livejournal.com
По крайне мере если ворд, то текстовый формат. Хотя толку от того, что тебе покажут дифф этих вещей. Там нифига не наглядно.

Date: 2009-12-19 01:30 pm (UTC)
From: [identity profile] permea-kra.livejournal.com
Тогда уж в докбуке.

Date: 2009-12-19 01:31 pm (UTC)
From: [identity profile] permea-kra.livejournal.com
А, не увидел коммент ниже.

Date: 2009-12-19 01:33 pm (UTC)
From: [identity profile] metaclass.livejournal.com
Докбук как-то печален. Хотя я его стили даже подгонял под то что мне нужно, но все равно - как-то неудобно.

Date: 2009-12-19 07:46 pm (UTC)
From: [identity profile] aamonster.livejournal.com
Угу, это уже понятно (у самого больше доверия вызывают простые текстовые форматы).

Date: 2009-12-20 04:31 pm (UTC)
From: [identity profile] kosiakk.livejournal.com
А мы пишем в Ворде 2007, со всеми его рюшечками.
Сохраняем в XML-виде (типа .docx.xml), а перед коммитом простая прога сканит все файлы и делает им code reformat (в идеале - триггер на коммит).

в итоге всё неплохо ложится в svn; есть примитивный xsl-шаблон, который делает из такого файла plain-text для ещё более простых дифов.

и скрипт на vba, который преобразует все файлы в pdf для клиентов.

так что, получается весьма кошерно.

Date: 2009-12-19 07:05 am (UTC)
From: [identity profile] inhate.livejournal.com
DocBook || Doxygen рассматривался?

Date: 2009-12-19 09:31 am (UTC)
From: [identity profile] metaclass.livejournal.com
Докбук сильно неудобнее, я его уже использовал. И как-то нормальный результат в латехе у меня быстрее получился.

Date: 2009-12-19 11:06 am (UTC)
From: [identity profile] alexott.livejournal.com
я докбук активно использовал, но надо повозиться с выгонкой в печатные варианты, особенно если пользоваться только бесплатными альтернативами
Хотя для докбука есть замечательный редактор Serna, который сейчас стал бесплатным (один из вариантов), там почти визивиг...
а для себя я давно перешел на emacs muse, и выгоняю из него и печатные варианты, и html, и даже сайт у меня из него генерится

Date: 2009-12-19 11:05 am (UTC)
From: [identity profile] alexott.livejournal.com
если несколько платформ, то лучше скачать сразу texlive и поставить его и на виндовс и на линукс. а то потом начинаются проблемы - на винде texlive 2009, в дебиане - 2007, пакеты не совпадают и т.п.

Date: 2009-12-19 05:28 pm (UTC)
From: [identity profile] theiced.livejournal.com
дык не юзайте бебиан и всё у вас будет.

Date: 2009-12-19 05:54 pm (UTC)
From: [identity profile] alexott.livejournal.com
убунта использует те же самые пакеты... да и в остальных дистрибутивах не всегда полный набор пакетов CTAN

Date: 2009-12-21 07:49 pm (UTC)
From: [identity profile] ilya-portnov.livejournal.com
Asciidoc или аналоги?

Profile

metaclass: (Default)
metaclass

April 2017

S M T W T F S
      1
2345678
9101112 131415
16171819202122
23242526272829
30      

Most Popular Tags

Style Credit

Expand Cut Tags

No cut tags
Page generated Aug. 25th, 2025 03:00 am
Powered by Dreamwidth Studios