Изложение текстов в общих топиках, внедряемых в идентичные разделы документов (книг) в AuthorIT

Создан 11.12.2006 14:44:54

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

- Требования к режимам функционирования системы

- Решения по режимам работы системы

Различие состоит в том, что в техническом задании фигурирует словосочетание должна обеспечивать (возможность)1, а в пояснительной записке - слово обеспечивает. Сходство же проявляется в том, что в обоих документах имеет место построение текста по схеме вводная фразаперечисление. Читатель, наверное, уже догадался, как использовать схему вводная фразаперечисление при создании общих топиков для идентичных разделов: следует создать вводные топики, содержащие чуть отличающиеся вводные фразы, а перечисление организовать одним топиком, общим для каждого из двух документов.

Общий топик, содержащий перечисление, должен быть создан единожды в любой из книг на основе шаблона No Heading Template, в противном случае после публикации любой из книг между вводной фразой и перечислением будет фигурировать заголовок общего топика. Но, коль скоро перечисление внедряется из требований в решения, общий топик целесообразно создавать в книге - Пиктограмма книги tz и в заголовке указать - ТЗ2 ..., чтобы всегда знать, какая из книг является первоисточником общего фрагмента текста.

Примечания от 19.08.2014:

  1. Обеспечивать - обязательное требование. Обеспечивать возможность - ближе к альтернативному, но вовсе не аналог. В первом случае предполагается, что процесс выполнения чего-либо автоматический, во втором - автоматизированный. Автоматический процесс должен выполняться любой ценой, не благодаря, а вопреки, автоматизированный зависит от оператора: захотел - запустил процесс, не захотел - не запустил. Но у оператора должна быть такая возможность.
  2. Это удобно в самом начале славного пути. Потом становится все равно, откуда что берется, поскольку режимы функционирования упоминаются как минимум в десяти документах комплекта. Когда библиотека взаимоувязанных документов готова, становится неважно, в каком из документов вносить изменения.