LINUX.ORG.RU
ФорумTalks

details - утилита по поддержанию детальной документации в актуальном состоянии

 


2

1

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

Я оценил всю крутизну деталей когда разработка проекта была прервана на три месяца. Благодаря им я легко вспомнил всё и легко продолжил проект. Предлагаю оценить и вам удобство такой документации, тем более что я написал няшную утилиту чтобы смотреть какие детали использованы, но ещё не описаны или наоборот найти неиспользуемые описанные детали:

https://github.com/unDEFER/details

Не в новостях потому что утилита очень уж мелкая и написана за пару часов..

★★★★★

Последнее исправление: unDEFER (всего исправлений: 3)
Ответ на: комментарий от unDEFER

Так какое теперь сообщение от libavl?

Там ещё много других ошибок, пока не собрал все.

У меня есть гипотеза, почему так произошло. В 2013-м году утилиту makeinfo, написанную на Си отправили в отставку, а вместо неё сделали симлинк на утилиту texi2any, написанную на Perl: Релиз texinfo 5.0

Может быть новую тему сделать, конкретно про texinfo?

Shushundr ★★★★
()

Ради баш-скрипта вы предлагаете запускать другой баш-скрипт, которые будет делать неизвестно что, устанавливая первый?

MoldAndLimeHoney
()
Ответ на: комментарий от MoldAndLimeHoney

Так это же универсальный установщик. Кочует из проекта в проект простым копированием.

unDEFER ★★★★★
() автор топика

Я ещё вот чего не понимаю. Рассмотрим программный продукт MS Office Word. Он позволяет создавать документы, и никто не знает, в каком формате он хранит информацию внутри себя. Продукт Libre Office Write, позволяет создавать документы, и кто-то знает, что он там что-то хранит по опубликованной спецификации, но по-настоящему внутрь никто не лезет.

Внимание вопрос - почему нет текстового процессора, который позволяет просто редактировать текст, хранить его в формате LaTeX, но никому не рассказывать об этом? Почему все редакторы LaTeX стремятся дать «двойное редактирование» и обрабатывают текст не в реалтайме, а внешним процессором. Ведь можно же сделать такой текстовый процессор, чтобы он редактировал всё что надо, делал .pdf и никому не говорил, что там LaTeX внутри (кроме git-репозитория, в котором всё хранится).

Shushundr ★★★★
()
Ответ на: комментарий от Shushundr

Продукт Libre Office Write, позволяет создавать документы, и кто-то знает, что он там что-то хранит по опубликованной спецификации, но по-настоящему внутрь никто не лезет.

Там xml внутри. Распакуй и лезь сколько надо.

Внимание вопрос - почему нет текстового процессора, который позволяет просто редактировать текст, хранить его в формате LaTeX, но никому не рассказывать об этом? Почему все редакторы LaTeX стремятся дать «двойное редактирование» и обрабатывают текст не в реалтайме, а внешним процессором. Ведь можно же сделать такой текстовый процессор, чтобы он редактировал всё что надо, делал .pdf и никому не говорил, что там LaTeX внутри (кроме git-репозитория, в котором всё хранится).

Зачем? Чтобы что?

А вообще точный ответ на твой вопрос такой: потому что его никто не написал.

wandrien ★★
()
Ответ на: комментарий от wandrien

Зачем? Чтобы что?

Чтобы пользователю было не нужно изучать формат TeXinfo, но при этом была возможность легко и удобно делать документацию к проектам GNU в соответствии с рекомендациями проекта GNU.

Shushundr ★★★★
()
Ответ на: комментарий от wandrien

Там xml внутри. Распакуй и лезь сколько надо.

Существует ли утилита командной строки, которая делает info-файлы из .odt ? Думаю, что она при этом теряет информацию. А вот если бы формат был заранее ограничен логикой текстового процессора. то информация бы не терялась бы.

Shushundr ★★★★
()
Закрыто добавление комментариев для недавно зарегистрированных пользователей (со score < 50)