Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Подзаголовки, без уровня — хорошо?
 
Коллеги, как по-вашему, хороша ли практика организации в разделе неких "внутренних" подразделов — не следующего уровня, а просто, как бы для структурирования, для упорядочивания?
У нас есть стили для заголовков 6 уровней. Последний, шестой, номера не имеет. Недавно я стала замечать, что этот шестой используется не только внутри пятого, но и в других — для членения их на некие смысловые куски, которые или невелики по объему, или довольно сильно связаны друг с другом, чтобы выделять их в самостоятельные разделы.

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

И чтоб два раза не ходить:
- единственный раздел следующего уровня — плохо?
- текст перед заголовком следующего уровня — плохо?
Я знаю, что Философт в "Проекте стандарта на стиль изложения документации пользователя программного средства" это запрещают. Но на практике почему-то сложно этого избежать... Или не сложно? Насколько тщательно вы за этим следите?

Спасибо.
 
Заголовки могут быть вообще без уровней. Вышестоящие и нижестоящие заголовки вполне могут выделяться только стилистически.
Если у вас есть заголовки 6-го уровня, то лучше пересмотреть структуру описания, если это возможно. Количество уровней >3 уже не очень. Если изменить структуру не получается, то лучше нумеровать все заголовки всех уровней.

- единственный раздел следующего уровня — плохо? Плохо.
- текст перед заголовком следующего уровня — плохо? Не очень поняла, что имеется в виду.
techwriter.ru.com
 
1.1. Заголовок текущего уровня
текст перед заголовком следующего уровня
1.1.1. Заголовок следующего уровня

Цитата из "Проекта стандарта": "Если внутри структурного элемента выделены структурные элементы следующего уровня, не допускается размещать какой-либо текст между началом исходного структурного элемента и началом первого по счету структурного элемента следующего уровня."
 
Цитата
Ирина Сидорова пишет:
Цитата из "Проекта стандарта": "Если внутри структурного элемента выделены структурные элементы следующего уровня, не допускается размещать какой-либо текст между началом исходного структурного элемента и началом первого по счету структурного элемента следующего уровня."
Очень субъективно. Если в разделе содержится несколько подразделов, то я считаю целесообразным привести в разделе краткую аннотацию к подразделам и привести ссылки для быстрого перехода, чтобы не заставлять пользователя перелистывать до нужного раздела.
techwriter.ru.com
 
Цитата
Ирина Сидорова пишет:
Цитата из "Проекта стандарта": "Если внутри структурного элемента выделены структурные элементы следующего уровня, не допускается размещать какой-либо текст между началом исходного структурного элемента и началом первого по счету структурного элемента следующего уровня."
Бред.
 
Спасибо, поняла))

А все-таки, по главному вопросу. Даже если не касаться максимального количества уровней и наличия/отсутствия цифр у заголовков, насколько хорошо такое "внутреннее" деление? Т.е. получается некая двойная система: деление "до конца", на нормальные подразделы, и деление "не до конца", на такие вот подраздельчики (сейчас подумала, что их можно было бы сравнить с крупными пунктами списка, просто озаглавленными).
 
Цитата
Ирина Сидорова пишет:
Спасибо, поняла))

А все-таки, по главному вопросу. Даже если не касаться максимального количества уровней и наличия/отсутствия цифр у заголовков, насколько хорошо такое "внутреннее" деление? Т.е. получается некая двойная система: деление "до конца", на нормальные подразделы, и деление "не до конца", на такие вот подраздельчики (сейчас подумала, что их можно было бы сравнить с крупными пунктами списка, просто озаглавленными).
Всё зависит от того, нужны ли эти подразделы в оглавлении :)
techwriter.ru.com
Страницы: 1
Читают тему