Re[2]: Какую документацию вы предпочтёте одно или много страничную?
От: velkin Земля  
Дата: 25.02.24 17:45
Оценка:
Здравствуйте, goto, Вы писали:

G>Обсуждаются крайности — это раз (оптимум может лежать посередине), не определена многостраничная — два (что есть страница?). Также зависит от типа документа, использования. В одном случае может быть хорошо то, в другом — это.


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

Тема про то до какой степени объединять многостраничную документацию тоже интересна. Когда остановить объединение, когда охвачено какое-то понятие или просто по главам. Или напротив пытаться всё разбить чуть ли не до абзацев и предложений, раз уж пошла такая тема для опытов. Но в данном случае документация рассматривается целиком вне зависимости от того какого она размера и может ли текущий компьютер её открыть (загрузить), разобрать (распарсить) и отобразить.

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

Тот же один файл pdf со всей документацией внутри можно условно считать одностраничной документацией, потому что там есть страницы, но это физические страницы для печати, а не логические страницы оглавления, но самое главное не нужно переоткрывать кучу файлов. А если это html и его производные, то это как раз наш случай, так как можно создать одну большую html страницу, а можно много небольших. И не важно подкачиваются они в онлайне или уже скачаны в офлайн.

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

Ключевые признаки я тоже описал. Если можно запустить поиск по странице, то есть нажать Ctrl+F и найти по тексту всё что угодно, перематывать всю документацию полосой прокрутки, не переходить на другую страницу при редактировании данных, то всё это признаки одностраничной документации. В противном же случае это многостраничная документация. Я думаю, что людям при голосовании не нужны столь обширные пояснения, вроде и так понятно к чему этот опрос.

По идее специальный софт мог бы.
1. Открывать множество файлов документации как один.
2. Разбивать один файл на множество независимых окон редактора.

Но тогда бы опрос сменился бы на то какое представление документации вы предпочитаете, одностраничное или многостраничное. Основная суть вопроса при этом бы не изменилась. Взять тот же chm (compiled html), важно ведь не то, что там один файл снаружи, а то что представление зависит от количества скомпилированных файлов html внутри. В него можно поместить как одностраничную, так и многостраничную документацию. И разница проявится прежде всего в представлении документации, а не в количестве внешних файлов.

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