ЛАТЕКС может использоваться для создания какой-либо документации, которая сопровождает программное обеспечение? [закрытый]
Я бы порекомендовал установить свою собственную базу данных на сервере с подсчетом «нравится и не нравится» и веб-сервисами, которые действительно нравятся и не нравятся, так как похоже, что вы хотите, чтобы это было многопользовательское приложение и подключенное к Интернету.
Буду признателен, если вы добавите больше подробностей о том, как вы хотите его реализовать, чтобы дать вам лучший ответ.
11 ответов
Я главным образом пишу научные работы с ЛАТЕКСОМ. Однако мое исследование имеет отношение к документации программного обеспечения, таким образом, я на самом деле имею дело с некоторыми из этих проблем.
лучшая вещь о ЛАТЕКСЕ состоит в том, что Вы обеспокоены содержанием и структурой, не просто визуальной разметкой. Это похоже на запись HTML с CSS, а не чистый HTML.
Вот несколько причин, что я думаю, что ЛАТЕКС полезен для создания некоторой документации:
Одна причина состоит в том, что контакт с несколькими стилями более структурирован, и стили более "логичны", чем "визуальный". Например, если Вы вводите в Word, каждый раз, когда Вы хотите упомянуть класс или объект, Вы изменяете стиль. В LateX, поскольку я ввожу, я пишу что-то как:
{нечто} bla bla bla ~\methodName bla bla ~\className {FooBar}.
я нахожу, что для длинных документов, это полезно. Я могу легко найти свои имена классов, изменить их, и т.д.
А второе преимущество - то, что я могу использовать макросы для объектов. Например, предположите, что у меня есть некоторый модуль, который обрабатывает некоторую функциональность, но что ее имя может измениться позже или что я не уверен, каково это. У меня может быть макрос, названный \ModuleForXXX, и когда я в конечном счете выбираю имя или изменяю его.
одна треть и возможно самое важное преимущество - то, что легче создать документ из иерархии файлов в ЛАТЕКСЕ, чем, одним словом, документ. У меня обычно есть основной файл, который затем включает другие файлы, которые затем включают другие файлы и так далее. Я просматриваю его иерархически (по крайней мере, в Windows с WinEDT), и я могу легко перестроить порядок вещей только путем изменения включений. Само собой разумеется, я также использую, включает для фактического содержания выборок кода и текста документации.
ЛАТЕКС имеет несколько недостатков хотя: 1) Немного людей знают это и некоторые люди, которые привыкли к Word, просто снова послал его. Однако для кого-то, кто читает заключительный PDF, он не должен иметь значения. 2) Размещение изображения может быть немного хитрым, хотя можно переопределить опции и вынудить ЛАТЕКС слушать инструкции. 3) Это работает лучше всего с конфигурацией парного монитора.
Много проектов в экосфере Python теперь используют Сфинкс для создания их документации. ЛАТЕКС является одним из многих выходных форматов, которые может произвести Сфинкс. Я полагаю что Doxygen, C ++/C/Python/Objective-C/.. механизм документации может также произвести ЛАТЕКСНЫЙ вывод.
В целом, проекты, где формат документации бумажной копии требуется или где документация обязательно содержит большую математику, извлекают выгоду значительно из сгенерированной ЛАТЕКСОМ документации - это, afterall специальность Латекса. ЛАТЕКС самостоятельно является общей наборной системой, не генератором документации кода, таким образом, я рекомендовал бы использовать пакет как описанные выше для генерации документации кода в ЛАТЕКСЕ. Используя одну из этих высокоуровневых систем значительно упростит задачу.
Экстенсивно используя ЛАТЕКС и также записанную документацию программного обеспечения, я сказал бы, что сила ЛАТЕКСА является очень гибкой системой типографии, такой, что переключение шаблонов и форматирование очень просты, и что запись математики довольно быстра. Я не думаю, что любые из тех преимуществ особенно полезны при записи документации, потому что для документации нужно много снимков экрана и пошаговых инструкций.
самой большой проблемой, которую я имею с ЛАТЕКСОМ, по крайней мере, TeXShop на Mac, является форматирование изображения и размещение. Инструменты в MS Office или OpenOffice намного более полезны для этого. Способность изменить гарнитуру хороша только при публикации к различным журналам; последовательный дизайн документации может быть легко обработан шаблонами и т.п. в офисном программном обеспечении.
Плюс, больше людей привыкло к офисному программному обеспечению, чем ЛАТЕКС, таким образом, учебная кривая меньше. Таким образом, когда следующий человек приезжает и должен обновить существующую документацию, они могут начать сразу же, вместо того, чтобы также иметь необходимость изучить ЛАТЕКС.
Я использовал его для документации программного обеспечения, и это работает вполне хорошо на это. Одно из ключевых преимуществ является простотой с документацией от многочисленных источников, может быть интегрирован. Можно (например), представить ссылку API или словарь данных для Пропитки латексом и перекрестная ссылка другие части спецификации к нему. Если можно поместить ЛАТЕКСНЫЕ отрывки в комментарии API, XREFs может даже пойти обоими путями.
ЛАТЕКС также очень хорош в поддержании индексов, Элементов оглавления и других таких объектов, таким образом, качество содержания документа намного лучше, чем с инструментами, такими как слово. Перекрестные ссылки, элементы индекса и привязки намного более стабильны.
Существует система Knuth CWEB, которая использует Техас http://www-cs-faculty.stanford.edu/~knuth/cweb.html
GNU Troff (Groff) , кажется, более популярен, чем ЛАТЕКС в сообществе программного обеспечения. Согласно Википедия , O'Reilly использует его для ее книг также.
Инструментарий Сегментации и Регистрации Понимания ( www.itk.org ) имеет очень прохладную систему, куда ЛАТЕКСНЫЙ источник помещается в комментарии исходного кода и их на самом деле genereate несколько hundered руководств по программированию страницы от него.
Некоторое большое программное обеспечение с открытым исходным кодом создает их документацию с нуля. Система документации Perl (POD, мужская документация) поддерживает экспортирование в ЛАТЕКС, который я раньше иногда печатал его.
Я не использовал ЛАТЕКС, так как я прекратил быть инженером-механиком. Я знаю, что это используется экстенсивно для наборных бумаг с математикой. Любой, кто представляет статью на рассмотрение журналом ASME, несомненно будет использовать его. Я использовал его для набора моей диссертации и любил его.
, Но с тех пор, я видел только Word без единственного исключения.
Я помог установить ЛАТЕКС в целях документации в прежней компании. Это работало, но техническим писателям не понравился он.
Основная жалоба была то, что они чувствовали, что это была неволя. Который был хорошей вещью, они не могли испортить вещи слишком много.
Это была довольно мало работы для установки класса документов, чтобы быть просто правильным, и размещение изображений никогда не было прекрасно во всех случаях, но заключительная документация была просто красива. Я сделал бы это снова, если дали выбор.
Я не был ЛАТЕКСНЫМ гуру затем (и все еще теперь), но Вам будет нужен кто-то хорошо осведомленный в ЛАТЕКСЕ, чтобы установить и поддерживать такое усилие, как большинство технических писателей не интересуется изучением внутренностей ЛАТЕКСА для поддержки себя.
Я иногда использовал его, но мой босс больше в офисные документы и если он пишет документацию или части ее, мы не используем ЛАТЕКС.
я лично люблю ЛАТЕКС и использую его также для документации программного обеспечения в соответствующих случаях и где я нахожусь в положении для решения этого сам.