Простой способ для личной документации программ

Изучаю разные большие программы (встроенные туториалы могут достигать 5000+ страниц) и хочу записывать нужны данные для себя. Что в принципе нужно: дерево элементов, ну и возможность вставить картинки, текст, список (ну и по мелочи). Казалось бы - HTML + немного CSS и вперед. Проблема только в одном - каждый раз лазить в код, прописывать теги ну и остальные мелочи. Мне бы не хотелось заморачиваться над этим, а использовать что то более быстрое в этом плане, ну типа готовый конструктор (создал ветку, закинул фотку + текст и готово). Ну и не плохо было бы эту "документация" локально на телефон перекидывать.
Из всех возможных вариантов что приходят в голову:
1) перечисленные html + css. Плюсы - функционал самое то, минусы - вечно лазить в код и вопрос переносимости на телефон
2) телеграм канал: сам канал это типа дерево элементов - а комменты это аналог html страницы (фотки, текст). Минусы в том, что тяжело переделать (поменять местами) + зависим от интернета + если что то пойдет не так с телегой то вся документация пропадет
3) создавать иерархию папок в проводнике (то же дерево элементов) и записи делать например в word'e. плюс - локально, минус - не самый удобный интерфейс получится + если будет желание сделать поиск - то явно не вариант
4) Конструктор сайтов. То регистрации, то бестолковые шаблоны, то вечно втюхивают ии, то дерева элементов нету. А жаль, возможно это было бы то что мне нужно (ну или я просто не нашел нужный мне вариант)

Я уверен что подобное уже существует, только не могу найти. Рассмотрю все варианты.

0

Enifan, Obsidian

2

+100 за obsidian.
Но надо изучить его диалект маркдауна для пущей эффективности.
И нет веб-интерфейса. Есть сторонняя попытка поднять vnc в браузере к виртуальному рабочему столу с десктопным приложением, но это совсем не то.

Ещё можно посмотреть

• joplin
• docmost
• alexandrie

1

Выбор "записных книжек" и систем документирования достаточно большой. Например, Evernote еще не называли. Но для документации подойдет CMS общего назначения, т.к. при документировании правки обычно происходят значительно реже, чем чтение. Чтобы не отягощать инструмент монолитной CMS, можно использовать и базу данных с каким-нибудь простым каркасом. Это простое форматирование содержимого на уровне HTML/CSS (заголовки, абзацы, списки, изображения и т.п.) и структурирование на уровне базы данных.

1

Самую простую иерархию делают на основе "списка смежности" совместно с "материальным путем". Иногда даже листья ("заметки" и т.п.) размещают в таблице категорий, используя логическое поле наподобие iscat(egory). Можно использовать разные таблицы (категорий и т.п.) для разных продуктов, чтобы можно было проще разделять документацию при необходимости. Например, в адресе на первом месте идут идентификаторы программных продуктов, а далее уже "материальные пути" из таблицы категорий, причем корень ветви можно спокойно разместить в таблице категорий, указав материальный путь, состоящий из пустой строки:
/collator <-> ''
/collator/intro <-> 'intro'
/collator/intro/prehistory <-> 'intro/prehistory'
etc.

Добавлено через 5 минут
На главной логично разместить список программных продуктов из "корневой" таблицы. Идентификаторы наподобие collator хранятся в ней. Более того я часто использую модели данных, в которых даже главная страница описана в базе данных, в той же самой "корневой" таблице с идентификатором, состоящим из пустой строки.

Добавлено через 1 минуту
А еще есть документооринтированные базы данных (выше я писал про реляционные).

0

Хочешь сделать "хорошо" - сделай сам. Делайте стартап с открытым исходным кодом. Будете исправлять проблемы хотя бы не чужие

0

0

NTHing, предлагаешь небольшое побочное неудобство превратить в основную проблему?)

0

Иногда, вместо того чтобы бороться с готовыми решениями, лучше сделать что-то свое, простое.

Для меня, например, документирование - фундаментальная вещь, поэтому не хочется зависеть в этом вопросе от сторонних решений. С другой стороны, если использовать что-то с открытым исходным кодом, можно будет продолжать этим пользоваться, даже если мэйнтейнер вдруг впадет в кому или решит все уничтожить.

0

Сообщение от Rius нет веб-интерфейса

Тут больше интересно не сам веб, а возможность перекинуть инфу на телефон (в дороге читать и тд), обсидиан с этим легко справляется - просто копирую папку "проекта" с пк и перемещаю на телефон и все работает. Читал что есть синхронизация, но пока и без нее хорошо.

Сообщение от estic CMS

С вебом почти не работал, решил загуглить подобное и в топе выдало WordPress. Глянул настройку сервера и думаю - чет сложно. После теста обсидиана прям головная боль. Но если планировать выставлять инфу на сайт (а этого в планах нету) - то было бы норм.

Сообщение от NTHing сделай сам

Честно говоря не вижу смысла плодить мульон подобных программ, все +- одинаково получится, + затратно по времени. Если бы не было в планах изучать парочку других программ (с докой 5000+ страниц) то по фану можно было бы, но переключаться на данный момент явно не лучшая идея.

0

Сообщение от Enifan Тут больше интересно не сам веб, а возможность перекинуть инфу на телефон (в дороге читать и тд), обсидиан с этим легко справляется - просто копирую папку "проекта" с пк и перемещаю на телефон и все работает. Читал что есть синхронизация, но пока и без нее хорошо.

Не, без синхронизации плохо.
Между ПК можно бесплатно синхронизироваться через плагин поддержки Git.
А вот со смартфонами беда.

0

Сообщение от Enifan Глянул настройку сервера и думаю - чет сложно.

Обычного виртуального хостинга будет достаточно.

Сообщение от Enifan Но если планировать выставлять инфу на сайт (а этого в планах нету) - то было бы норм.

Основной плюс Вэба в том, что не нужно ничего синхронизировать и т.п. Закрыть доступ можно при помощи авторизации или вовсе ничего не закрывать, если нет никаких секретов.

Хотя документацию можно держать и локально на домашнем ПК и т.п. В этом случае уже нужно думать о дублировании или доступе извне. И настраивать локальный Web-сервер и т.п. Это не очень сложно. Основное преимущество локальных Web-сервисов над десктопными приложениями мы уже оговорили: при желании можно легко перенести в публичный Вэб.

1