Здравствуйте, goto, Вы писали:

G>Все это стоило определить перед опросом. Теперь результаты опроса можно выбросить, т.к. вводные некоторыми были поняты не так, и уже ничего не вернешь.

Всё нормально, некоторые голосовали прямо со страницы опросника ещё до создания данной темы. Мне какая-то особая точность не требуется. И даже если кто-то ошибётся в понимании тоже ничего страшного не произойдёт.

G>Если в начале я увидел крайности, то с уточнениями вообще не понимаю, что там обсуждать. Кажется размытым и беспредметным, что ли. В чем проблема-то?

Зачем я создал этот опрос? Чего я хочу этим добиться?



В общем может кто видел, что я начал вести личную базу знаний и даже создал несколько тем в блогах по ним. Я даже Obsidian недавно проверил, не только Zim на предмет пригодности.

Но произошло буквально следующее, я включил идущие в составе Zim плагины.
1. Обратные ссылки.
2. Метки.
3. Вложения.

И я обнаружил, что.
1. Благодаря обратным ссылкам некоторые вспомогательные ссылки в содержимом мне больше не нужны.
2. Метки они же теги позволяют уменьшить названия за счёт того, что служат дополнительными уточнениями, которые уже не нужно делать в самом названии.
3. А вложения позволили мне осознать, что ими проще управлять, если документация одностраничная.

Причём окно вложений может сворачиваться, на скриншоте ниже я его развернул.



Смысл в том, что тот же Qt слишком обширен для сворачивание документации в одну страницу, но это можно сделать для каждого класса, то есть не разбивать его на члены. Это можно частично сделать для примеров кода или для целых программ.

В принципе для любых не бьющихся понятий встаёт выбор.
1. Или одностраничная документация с автоматически создаваемым по заголовкам "Оглавление" справа, это видно на скриншоте.
2. Или подстраницы со ссылками, тогда переход будет осуществляться с помощью "Содержание" слева, это тоже видно на скриншоте.

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

Создав данную тему я.
1. Сформулировал отличия видов документаций.
2. Получаю статистику по предпочтениям других людей.
3. Получаю дополнительные мысли в чужих комментариях.

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

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