Holarch

Требования

Документы

Написание, структурирование, нумерация, включение в базовую линию и публикация спецификаций как живых представлений модели, с шаблонами, форматированным текстом, отчётами и выводом в Word.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Что делает что-либо документом
    2. Типы документов
    3. Числа
    4. Базовые линии
  3. Как использовать
    1. Когда и зачем
    2. Создание спецификации требований из шаблона
    3. Написание требований
    4. Быстрое добавление множества требований
    5. Реструктуризация
    6. Рецензирование, базовая линия и публикация
    7. Рабочий пример: демо CubeSat EO-1
    8. Советы и рекомендации
    9. Типичные ошибки
    10. Связь с другими функциями
  4. Список документов
  5. Страница документа
    1. Заголовок страницы
    2. Панель инструментов
    3. Панель структуры
    4. Тело документа
    5. Контекстное меню
    6. Быстрое добавление
    7. Инспектор
  6. Добавление элементов
    1. Новые элементы
    2. Другие классы
    3. Структурированные документы с Heading
    4. Существующие сущности
  7. Реструктуризация
    1. Отступ, выступ и перемещение
    2. Перетаскивание
    3. Перемещение под элемент
  8. Нумерация
    1. Автоматическая перенумерация
    2. Правила следующего номера
    3. Перенумерация
    4. Нумерация документа (метаномера)
  9. Шаблоны
    1. Встроенные шаблоны
    2. Сохранение документа как шаблона
    3. Управление шаблонами
    4. Шаблоны, сохранённые в этом браузере
    5. Применение шаблона к существующему документу
  10. Редактор форматированного текста
    1. Панель инструментов
    2. Таблицы
    3. Изображения и файлы
    4. Замещающий текст
    5. Ссылки и встроенные ссылки
    6. Динамическое содержимое
    7. Текстовые инструменты ИИ
    8. Вставка
    9. Сочетания клавиш форматированного текста
  11. Поиск в документе
  12. Найти и заменить
  13. Меню “Писать”
    1. Задание атрибута в ветви
    2. Разделение на несколько элементов
  14. Меню “Проверить”
    1. Статус прослеживания
    2. Поиск сокращений
  15. Меню “Поставка”
    1. Шаблоны Word
    2. Файлы Word компании
  16. Меню “Вид”
  17. Базовые линии
    1. Создание базовой линии
    2. Просмотр базовой линии
    3. Сравнение версий
  18. Отчёты
  19. Вывод в Word
    1. Подписи, списки и перекрёстные ссылки
    2. Настройка поставляемого документа
    3. Формат страницы
    4. Преобразование форматированного текста
    5. Исправления
    6. Печать / PDF
  20. Комментарии
  21. Сборники
    1. Сгенерированные разделы
    2. Сборник в Word
  22. Инструменты ИИ
  23. Сочетания клавиш
  24. Настройки, запоминаемые в этом браузере
  25. Сообщения
  26. Ограничения
  27. Связанные материалы

Обзор

Документ — это спецификация, план или процедура, разделы и требования которой являются сущностями модели. На странице документа их пишут и реструктурируют, нумеруют, создают для них базовые линии и публикуют в Word, Excel, ReqIF, Markdown и другие форматы.

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

Понятия

Что делает что-либо документом

  • Документ — это сущность Artifact, удовлетворяющая одному из двух условий:
    • У неё есть метка типа документа: любая метка, имя которой заканчивается на “Document”.
    • Она является source of хотя бы для одного Statement или Heading.
  • Её элементы верхнего уровня — сущности, для которых документ является source of. Более глубокие элементы подвешены под ними через связи decomposed by. Видимая структура — это дерево этой декомпозиции.
  • Элементы — обычно Statement (разделы, заголовки, примечания, допущения) и Requirement (и их подклассы). Любой другой класс добавляется через Другой класс….
  • Heading (структурированные документы LML 2.0) — это разделы, содержащие элементы любого класса. Подраздел — это Heading под Heading (decomposed by). Любой другой элемент под Heading — это содержимое раздела: Heading его contains, элемент сохраняет свой номер и перечисляется перед подразделами. См. Структурированные документы с Heading.
  • Удаление элемента из документа не удаляет сущность. Удаление из базы данных — удаляет.

Типы документов

Тип — это метка типа документа. Он определяет, какие шаблоны предлагаются первыми и открывается ли документ в режиме бумаги.

ТипВстроенные шаблоны
Requirements DocumentRequirements Specification; Stakeholder Requirements Specification (StRS); System Requirements Specification (SyRS); Software Requirements Specification (SRS); Interface Requirements Specification (IRS)
Interface Control DocumentInterface Control Document (ICD)
Concept of Operations DocumentConcept of Operations
Needs Analysis DocumentNeeds Analysis
Concept Exploration DocumentConcept Exploration; Trade Study Report
Concept Definition DocumentConcept Definition; Architecture Description
Systems Engineering Management Plan DocumentSystems Engineering Management Plan
Test Plan DocumentTest Plan; Verification and Validation Plan; Test Procedure; Test Report
Independent Verification & Validation Plan DocumentIV&V Plan
Project Management Plan DocumentProject Management Plan; Risk Management Plan; Configuration Management Plan
Integrated Logistics Support Plan DocumentIntegrated Logistics Support Plan
Standard Operating Procedure DocumentStandard Operating Procedure

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

Чтобы добавить тип документа, добавьте классу Artifact метку, имя которой заканчивается на “Document” (см. Расширения схемы). Документ с меткой Пакет рецензирования собирает другие документы; см. Сборники.

Числа

У каждого элемента есть номер, например 3.2, показанный перед именем. Номера хранятся в сущности, поэтому одно и то же требование везде показывает один номер. Исключение — нумерация документа, которая хранит отдельные номера для каждого документа.

Holarch поддерживает порядок номеров за вас, пока включено Перенумеровывать автоматически после добавления или перемещения элементов (по умолчанию; флажок находится в Писать ▾ → Перенумеровать…).

Базовые линии

Базовая линия — это снимок документа только для чтения. Она содержит:

  • Элементы документа, их атрибуты и связи, включая связи с сущностями на один шаг за пределами документа.
  • Настройки документа.
  • Датированные записи об утверждении, которые нельзя изменить позже.

Базовые линии питают отчёты об изменениях и таблицы Revision History и Approvals вывода Word.

В размещённом сервисе:

  • Каждая запись об утверждении получает время сервера и учётную запись, которая её сохранила, а не часы браузера. Запись показывает “(server time) · recorded by {name}”, а сохранение записывается в журнал аудита.
  • Переименовать или удалить базовую линию могут только владельцы проекта. Для остальных Удалить и поле имени неактивны с пояснением “Переименовать или удалить базовую линию может только владелец проекта.” Восстановление и возврат работают как прежде.

В настольном приложении записи несут дату, когда их сохранил ваш компьютер.

Как использовать

Когда и зачем

Используйте документ, когда поставляемый результат — спецификация, которую будут читать, рецензировать и подписывать. Примеры:

  • Спецификация системных требований для SRR.
  • Концепция эксплуатации на раннем этапе разработки концепции.
  • План испытаний перед началом верификации.
  • Процедура для эксплуатации.

Пишите требования здесь, а затем прослеживайте их к функциям, ресурсам и тестам в других частях модели. Документ отвечает на вопрос “Что говорит эта спецификация, в каком порядке и что изменилось после её утверждения?”

В процессе системной инженерии документы идут первыми: потребности заинтересованных сторон и системные требования. Они питают функциональный анализ и распределение. На рецензированиях они возвращаются как утверждённые результаты с базовыми линиями и отчётами о прослеживаемости.

Создание спецификации требований из шаблона

  1. На панели навигации откройте Потребности и требования → Документы.
  2. Нажмите + Новый документ в заголовке страницы.

    Откроется Новый документ.

  3. Введите Имя (обязательно). Номер и описание можно добавить позже в инспекторе.
  4. В разделе Шаблон поле Шаблоны для показывает шаблоны одного типа документа, например Requirements Document. Каждая карточка показывает первые разделы в качестве предпросмотра. Выберите одно из:
    • Пустой: пустой документ показанного типа.
    • Запись из Шаблоны организации (серверы Holarch, размещённые или собственные), опубликованная администраторами вашей организации. Шаблон организации по умолчанию для типа выбран заранее.
    • Запись из Шаблоны проекта, сохранённая в этом проекте.
    • Запись из Встроенные шаблоны.
    • Шаблон другого типа документа в разделе Другие шаблоны.

      Документ получает тип выбранного шаблона.

  5. Отметьте Включить рекомендации по написанию, чтобы добавить краткое руководство по написанию в каждый раздел встроенного шаблона.
  6. Нажмите Создать.

    Документ открывается с нумерованными разделами шаблона, например 1 Document Control, 1.1 Revision History, 1.2 Approvals, 2 Introduction … Если вы включили рекомендации по написанию, удаляйте их по мере написания каждого раздела.

Написание требований

  1. Щёлкните строку раздела, чтобы выбрать её.
  2. Нажмите + Дочерний или ⌥⌘↵ / Ctrl+Alt↵.

    Появится новая строка “New Requirement” со своим номером, и её имя готово для ввода.

  3. Введите имя и нажмите Enter.
  4. Щёлкните описание и напишите утверждение с “shall”.
  5. Нажмите ⌘↵ / Ctrl↵ или щёлкните в другом месте, чтобы сохранить описание.
  6. Чтобы добавить следующее требование на том же уровне, снова нажмите ⌘↵ / Ctrl↵.

+ Создать … (заголовок страницы) добавляет элемент в конец документа; + После и + Дочерний добавляют его рядом с выбранным элементом (это сказано в подсказке + Создать …). Все три добавляют последний класс, выбранный в их меню ▾ (по умолчанию Requirement). Этот браузер запоминает выбор.

Быстрое добавление множества требований

Используйте Быстрое добавление внизу документа, чтобы вводить требования одно за другим.

  1. В строке Быстрое добавление выберите раздел, например Под 4 Command and Data Handling.
  2. Введите текст требования.
  3. Нажмите Enter.

    Holarch добавляет требование и называет его по словам после “shall”. Курсор остаётся в поле для следующего.

Реструктуризация

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

  • Клавишами: выберите строку, затем нажмите:
    • ⌥⇧→ / Alt+Shift+→, чтобы сдвинуть её под элемент выше.
    • ⌥⇧← / Alt+Shift+←, чтобы сдвинуть её влево.
    • ⌥ / Alt+↑ или ⌥ / Alt+↓, чтобы переместить её среди соседних элементов.
    • Tab не используется для отступа, поэтому всегда переходит к следующему полю.
  • Перетаскиванием: перетаскивайте строки на панели Структура. Отпустите на верхнем или нижнем крае строки, чтобы поместить элемент перед ней или после неё. Отпустите в середине, чтобы сделать его дочерним.
  • Из меню: щёлкните строку правой кнопкой, выберите Переместить внутрь ▸, затем выберите нового родителя из списка (введите текст для фильтрации). Дочерние элементы перемещаются вместе с ним.

Рецензирование, базовая линия и публикация

  1. Выберите Проверить ▾ → Проверить качество и исправьте слабые требования (см. Требования).
  2. Выберите Проверить ▾ → Статус прослеживания… и свяжите требования, которые ещё не распределены или не верифицированы.
  3. Закройте открытые пункты в Проверить ▾ → Реестр TBD/TBR.
  4. Просмотрите Проверить ▾ → Ссылки для проверки.
  5. В штампе нажмите Версия ▾ и выберите Сохранить базовую линию….
  6. Введите имя, например “SRR Baseline”.
  7. Добавьте по строке утверждения на каждого утверждающего: имя, роль и заявление.
  8. Нажмите Создать.

    Базовая линия появляется в Версия ▾, и кнопка называет её последней базовой линией.

  9. Нажмите Поставка ▾ → Спецификация (Word).

    Скачивается файл Word с параметрами шаблона “Спецификация”, включая таблицы Revision History и Approvals, заполненные по базовым линиям.

  10. Откройте файл в Word и согласитесь на обновление полей.

    Оглавление заполняется.

Чтобы документ прорецензировали до базовой линии, нажмите Запросить рецензирование рядом с типом документа. Рецензенты проекта находят его в разделе Документы на рецензирование на странице Моя работа и утверждают или отклоняют его там или в полосе под заголовком.

После последующих правок посмотрите, что изменилось:

  1. Нажмите Версия ▾ → Сравнить версии….
  2. Выберите базовую линию в поле От и Текущая версия в поле До.

    Отчёт перечисляет все добавления, удаления и правки. Нажмите Изменения (Excel), чтобы скачать его, или Исправления (Word) — для файла Word с записанными исправлениями.

Рабочий пример: демо CubeSat EO-1

Создайте демо-проект через Управление проектами → Файлы проектов ▾ → Новый демо-проект. Затем откройте Потребности и требования → Документы → EO-1 System Requirements Specification (номер SRS-001).

Прочитайте структуру. Требования содержатся в шести разделах:

  • 1 Mission Imaging
  • 2 Attitude Determination and Control
  • 3 Electrical Power
  • 4 Command and Data Handling
  • 5 Communications
  • 6 Ground Segment and Operations

У требования 1.6 Revisit Time два дочерних: 1.6.1 Ground Track Repeat и 1.6.2 Off-Nadir Imaging. Столбец Оценка качества показывает полосы. 2.5 Safe Mode Recovery и 6.4 Operator Interface получают низкие оценки.

Исправьте слабые формулировки:

  1. Нажмите ⌘F / Ctrl+F и введите should.

    Счётчик показывает совпадения.

  2. Нажимайте Enter, пока не будет отмечено 2.5.

    Его текст: “The spacecraft should recover from safe mode quickly and resume imaging as appropriate”.

  3. Перепишите его, например: “The spacecraft shall resume imaging within 24 hours of a safe mode entry.”

    Столбец оценки показывает тег Устарело, пока вы снова не запустите проверку.

Разделите составное требование:

  1. Выберите 6.4 Operator Interface (“…shall be user friendly and/or easy to use.”).
  2. Щёлкните его правой кнопкой и выберите Разделить на несколько элементов….
  3. Нажмите ✦ Предложить разделение.

    Вы получите по одному измеримому требованию на строку.

  4. Снимите отметки со строк, которые вам не нужны, или нажмите Объединить, чтобы слить строку со следующей, и нажмите Применить.

Быстро добавьте требование:

  1. В строке Быстрое добавление выберите Под 3 Electrical Power.
  2. Введите “The EPS shall provide a 5 V regulated bus within 3%.” и нажмите Enter.

    Оно добавляется как 3.7 с именем “Provide A 5 V Regulated”.

Посмотрите, что изменилось после SRR:

  1. Нажмите Версия ▾ в штампе и выберите SRR Baseline.

    Баннер гласит “Базовая линия “SRR Baseline”, только чтение, сохранено {date}”. Утверждающие: J. Rivera, Systems Lead; R. Okafor, Mission Principal Investigator; и L. Brandt, Program Manager.

  2. Нажмите Сравнить с текущей.

Отчёт перечисляет:

  • 3.1 Orbit Average Power: описание изменено с 28 W на 30 W, и новое обоснование.
  • 2.4 Target Slew: Status Draft → In Review.
  • Добавленное 4.4 Downlink Encryption с двумя новыми связями satisfies.
  • Ваши собственные правки за этот сеанс.

Опубликуйте:

  1. Нажмите К текущей версии.
  2. Нажмите Поставка ▾ → Спецификация (Word).

    Файл Word начинается с заголовка и “Requirements Document · No. SRS-001”. Далее идут строка Revision History для SRR Baseline (“Initial baseline”) и три утверждения, затем нумерованные требования.

Советы и рекомендации

  • Пишите одно требование на строку, с одним “shall”. Разделить на несколько элементов… и проверка качества помогают сохранять требования единичными.
  • Оформляйте разделы как Statement, а требования — как Requirement. Проверка качества оценивает только Requirement. Отчёты только по требованиям (RVTM, VCRM, RTM) пропускают Statement.
  • Создавайте базовую линию перед каждым рецензированием и перед крупными переработками. От этого зависят возврат и отчёты об изменениях.
  • Щелчок по строке выбирает её. Чтобы изменить, щёлкните само поле или нажмите Enter или F2 на выбранной строке.
  • Используйте Вид ▾ → Бумага, чтобы читать документ как страницу, без столбцов атрибутов. Выключите режим, чтобы изменять атрибуты в столбцах.
  • Следите за точками статуса прослеживания: требование готово к рецензированию, когда его точка зелёная.

Типичные ошибки

  • Добавление неактивно. Включён фильтр или сортировка (Отфильтрованный вид: редактирование отключено. Сбросить фильтр на панели инструментов) или вы просматриваете базовую линию. Щёлкните предупреждение или нажмите К текущей версии.
  • Номера скакнули после перемещения. Автоматическая перенумерация переписывает номера группы соседних элементов. Чтобы сохранить номера, заданные вручную, снимите флажок Перенумеровывать автоматически после добавления или перемещения элементов в Писать ▾ → Перенумеровать… или заблокируйте элементы, номера которых не должны меняться.
  • Элемент убран, но остался в базе данных. Убрать только исключает его из документа. Чтобы удалить его, выберите Удалить элемент… в появившемся сообщении, щёлкните Убрать с ⇧ / Shift или нажмите ⇧Delete / Shift+Delete.
  • Буквенная или римская нумерация стала десятичной. Автоматическая перенумерация и Перенумеровать… создают десятичные номера (1, 1.1, 1.1.1). Чтобы сохранить приложения с буквенной нумерацией, выключите автоматическую перенумерацию и нумеруйте их вручную.

Связь с другими функциями

  • Получает данные из:
    • Импорт создаёт документы из Word, Excel, CSV, ReqIF, XMI и текста.
    • Шаблоны создают каркас.
    • Генераторы ИИ добавляют требования.
  • Передаёт данные в:
  • Везде: каждый элемент — это сущность. Он появляется в базе данных, представлении элемента и на диаграммах, таких как Spider и древовидная.

Список документов

Список документов показывает все документы проекта карточками, в той же галерее, что и страница “Диаграммы”. Откройте его через Потребности и требования → Документы.

Каждая карточка показывает:

  • Миниатюру структуры документа.
  • Имя, тип и время последнего изменения (последнее изменение документа или любого элемента).
  • “N элементов · N требований”.
  • Среднее качество N%, если у требований есть оценки.
  • N TBD/TBR: открытые пункты.
Элемент управленияЧто он делает
Поиск документов…Показывает карточки, имя, номер или описание которых содержит текст.
СортировкаНедавно изменённые (по умолчанию), Номер (порядок структуры), Имя, Класс.
Кнопки-плашки типовВсе и по плашке на каждый тип документа с числом.
Показать ещё (N)Показывает больше карточек.
Импортировать (заголовок страницы)Открывает страницу импорта (Импорт и экспорт).
+ Новый документ (заголовок страницы)Открывает Новый документ.
⋯ на карточкеОткрыть, Открыть в ▸ Представление элемента, Дублировать… и Удалить….

Удалить… открывает Удалить документ: “Удаляет “…”. Его N разделов остаются в проекте как элементы.” Если некоторые разделы не входят ни в один другой документ, Также удалить N разделов, которые не используются другими документами удаляет и их. Отмена восстанавливает всё.

Щёлкните карточку, чтобы открыть документ.

Адрес documents/<id> открывает документ напрямую. Добавьте ?baseline=<id> или ?baseline=latest, чтобы открыть базовую линию, ?find=<text>, чтобы начать поиск, или ?comments=1, чтобы показать комментарии документа в инспекторе.

Страница документа

Страница документа показывает один документ в виде структуры и таблицы, а выбранный элемент — в инспекторе.

  • + Новый {Class} добавляет элемент текущего класса в конец документа. Его ▾ открывает меню классов:
    • Добавить существующий элемент….
    • Вставить документ… и Вставить сгенерированный раздел… (только сборники).
    • Под заголовком Добавить в конец: каждый класс Statement и Заголовок (у текущего ✔), а также Другой класс….
  • ✦ ИИ ▾ (на верхней панели) содержит инструменты ИИ документа (см. Инструменты ИИ).

Панель инструментов

Элемент управленияЧто он делает
+ ПослеДобавляет элемент после выбранного, на том же уровне (⌘↵ / Ctrl↵). Его ▾ добавляет Добавить существующий элемент…, Добавить дочерний (⌥⌘ / Ctrl+Alt↵) и список классов под Добавить после выбранного элемента.
+ ДочернийДобавляет дочерний элемент выбранного (⌥⌘↵ / Ctrl+Alt↵). Его ▾ предлагает Добавить существующий элемент… и список классов под Добавить дочерний.
⇤ / ⇥Сдвинуть влево (⌥⇧← / Alt+Shift+←) / вправо (⌥⇧→ / Alt+Shift+→) выбранный элемент.
↑ / ↓Переместить выбранный элемент вверх или вниз среди соседних (⌥ / Alt+↑ / ⌥ / Alt+↓).
УбратьСразу убирает выбранные элементы и их поддеревья из документа (Delete делает то же). Убрано из документа. предлагает Отменить и Удалить элемент…. Щелчок с ⇧ / Shift или ⇧Delete / Shift+Delete удаляет элементы и их дочерние после подтверждения, называющего удаляемое. Esc или × инспектора снимает выделение.
Писать ▾Добавление, вставка, генерация и правка содержимого (см. Меню “Писать”).
Проверить ▾Качество, проверки модели, статус прослеживания, ссылки для проверки, TBD/TBR и комментарии к этому документу с числами (см. Меню “Проверить”).
Поставка ▾Настройка поставки и страницы, шаблон Word, версии и экспорт, сгруппированный по виду вывода (см. Меню “Поставка”).
Вид ▾Прямые переключатели для этого документа: “Бумага”, “Панель структуры”, “Статус прослеживания” и “Столбцы” (см. Меню “Вид”).
Отфильтрованный вид: редактирование отключено. Сбросить фильтрПоявляется, пока включён фильтр по классу или метке либо сортировка столбца. Щёлкните, чтобы сбросить их.
НайтиОткрывает поле поиска (⌘F / Ctrl+F).

Кнопки структуры недоступны, когда:

  • Ничего не выбрано.
  • Выбранный элемент заблокирован.
  • Включён фильтр или сортировка.
  • Вы просматриваете базовую линию.

Панель структуры

Панель структуры слева показывает иерархию документа, с фильтром вверху. Вкладок нет: базовые линии находятся в Версия ▾ штампа, а комментарии открываются в инспекторе.

  • ‹ скрывает панель, а › у левого края снова показывает её (также Вид ▾ → Панель структуры).
  • Перетащите её правый край, чтобы изменить ширину (от 180 до 500 px).
  • Выбор элемента открывает инспектор рядом с панелью; панель остаётся открытой.
  • Если у панели и документа вместе меньше 900 px (с учётом открытого инспектора, чтобы выбор элемента ничего не менял), панель сворачивается. Тогда она открывается поверх содержимого по кнопке ›. Щёлкните за её пределами, чтобы закрыть.

Фильтр вверху панели:

  • Фильтровать структуру сужает структуру до элементов, номер или имя которых содержит текст, включая свёрнутые. Их родители остаются в структуре, затенёнными, для контекста. Документ при этом не фильтруется.
  • Чипы классов, по одному на каждый класс в документе, с числом (показываются, когда в документе больше одного класса). Щёлкните чип, чтобы показать в документе только этот класс и его подклассы; щёлкните снова, чтобы показать все классы. Щёлкните чип правой кнопкой, чтобы выбрать {Class} и подклассы, Только {Class} и Сбросить фильтр классов.
  • Чипы меток, по одному на каждую метку, используемую в документе, с числами. Щёлкайте чипы, чтобы показать только элементы со всеми выбранными метками. Для элементов с любой из нескольких меток используйте запрос в базе данных.
  • Если чипов больше шести, они сворачиваются за кнопкой Фильтр по классу или метке (n); в свёрнутом виде видны только действующие чипы. Меньше фильтров снова сворачивает их. Этот браузер запоминает выбор.
  • Сбросить фильтр появляется, пока включён фильтр или сортировка. Отфильтрованные строки сохраняют отступы. Пока включён фильтр или сортировка, редактирование отключено.

Структура:

  • У каждого элемента есть образец цвета, номер и имя, 🔒 при блокировке и переключатели ▾/▸.
  • Щёлкните запись, чтобы выбрать элемент и прокрутить к нему.
  • Перетаскивайте, чтобы изменить порядок (см. Перетаскивание). Недопустимые места сброса помечаются и отклоняются: элемент нельзя поместить под собственный дочерний, под заблокированный элемент или под класс, который не может быть им decomposed by.
  • Строки части документа, находящейся в поле зрения, подсвечены, и структура прокручивается вместе с документом. Она остаётся на месте, пока вы наводите на неё указатель, работаете в ней или прокручивали её в последние две секунды.
  • Глубокие уровни, которые не помещаются, показывают тег уровня L{n} вместо дополнительного отступа.

Тело документа

Тело начинается со штампа: тип и метки документа, число элементов, “нумерация по документу”, когда включены номера документа, 💬 n открытых комментариев (если они есть; см. Комментарии) и Версия ▾ (см. Базовые линии). Версия ▾ показывает Текущая версия, Текущая · последняя базовая линия {name} или Базовая линия: {name}. Под ними:

  • № и заголовок: щёлкните, чтобы изменить номер и имя документа, или перейдите к ним клавишей Tab и нажмите Enter или F2.
  • Описание документа: щёлкните, чтобы изменить его в редакторе форматированного текста, или перейдите к нему клавишей Tab и нажмите Enter или F2.
  • Таблица. Столбец Сущность содержит каждый элемент: переключатель, номер, имя, значки и описание. Остальные столбцы — столбцы атрибутов, выбранные в Вид ▾ → Столбцы ▸: Status, Verification Method и Оценка качества, пока вы их не измените. В режиме бумаги их нет.

Каждая строка показывает:

  • ▾/▸, чтобы свернуть или развернуть её дочерние элементы.
  • Номер и имя. Щёлкните, чтобы изменить, или перейдите к полю клавишей Tab и нажмите Enter или F2. Enter сохраняет, а Esc отменяет; фокус остаётся на поле. Вставленные переносы строк становятся пробелами.
  • Значки:
    • 🔒: элемент заблокирован.
    • ⚡: у элемента есть рекомендации. Наведите на значок указатель, чтобы прочитать их.
    • 💬 n: неразрешённые комментарии. Щёлкните, чтобы открыть их в инспекторе.
    • ⚠ Рецензировать: изменилось вышестоящее требование.
    • Значок класса.
    • Точка статуса прослеживания (только для требований; см. Статус прослеживания).
  • Описание, изменяемое в редакторе форматированного текста.
  • Цветная полоса у левого края: синяя, если элемент не изменился с последней базовой линии, янтарная, если он новый или изменён.
  • Ячейки атрибутов:
    • Метки показывают чипы с × для удаления и + для добавления. Меню перечисляет метки, которые допускает класс, или “Больше меток нет”.
    • Текстовые атрибуты изменяются на месте. Остальные используют редактор своего типа.
    • Оценка качества показывает цветную полосу: зелёную от 67 % и выше, янтарную от 34 % до 66 %, красную ниже. Если текст изменился после последней проверки, показывается тег Устарело со значком часов; наведите на него указатель, чтобы увидеть причину.
    • “—” означает, что у класса нет такого атрибута.

Сортировка и ширина столбцов:

  • Щёлкните заголовок столбца, чтобы отсортировать по возрастанию, ещё раз — по убыванию, а третий раз — чтобы выключить сортировку.
  • Сортировка показывает элементы плоским списком, без иерархии, и приостанавливает редактирование.
  • Перетащите правый край заголовка, чтобы изменить ширину столбца. Столбец “Сущность” не уже 300 px, остальные — не уже 80 px. Ширина хранится для каждого документа в этом браузере.
  • Пустая строка-разделитель отделяет разделы верхнего уровня.

Выбор строк:

  • Щёлкните строку, чтобы выбрать её. Щелчок только выбирает; чтобы изменить, щёлкните поле или нажмите Enter или F2 на строке.
  • Чтобы снять выбор, щёлкните пустое место под таблицей, нажмите Esc или ✕.
  • ↑ и ↓ перемещают выбор между строками.
  • Щелчок с ⌘ / Ctrl (Ctrl-щелчок в Windows и Linux) добавляет элемент в выделение или убирает из него.
  • Щелчок с ⇧ / Shift выбирает диапазон от последнего щёлкнутого элемента до этого в показанном порядке (с учётом сортировки или фильтра). Щелчок с ⌘ / Ctrl+⇧ / Shift добавляет этот диапазон к выделению.
  • ⌘A / Ctrl+A на элементе в фокусе (не во время правки) выбирает все показанные элементы. ⇧ / Shift+↑ и ⇧ / Shift+↓ расширяют выделение от элемента в фокусе.
  • Те же жесты работают в Структура. Панель инструментов показывает число (“Выбрано: 21”). Обычный щелчок или Esc возвращает к одному элементу.
  • Щелчки в поле, которое вы редактируете, ведут себя как обычно для текста: щелчок с ⇧ / Shift там расширяет выделение текста.

Контекстное меню

Щёлкните правой кнопкой элемент документа (его номер, имя, значки или пространство вокруг них) или запись в Структура, чтобы открыть его меню у указателя. С клавиатуры наведите фокус на строку или запись структуры и нажмите Shift+F10 или клавишу меню; меню открывается у элемента, а Esc возвращает туда фокус. На сенсорном экране коснитесь элемента и удерживайте. Элемент становится выделением.

Меню начинается с не более чем трёх предлагаемых действий, выбранных по состоянию элемента, каждое с причиной справа: например, ✦ Добавить измеримые критерии… (не проходит: Unambiguous), ✦ Сгенерировать тестовый случай… (не верифицировано), Проверить ссылку… (изменился вышестоящий элемент) или Разрешить TBD… (открытый TBD). Если исправлять нечего, предлагаются ✦ Проверить с ИИ… и ✦ Спросить ИИ об этом…. ✦ Ещё ИИ ▸ перечисляет все действия ИИ для элемента. Правила и полный список приведены в разделе Модель и база данных. Каждое действие ИИ показывает результат для проверки до каких-либо изменений. Когда ИИ выключен, часть ИИ — одна неактивная строка с указанием причины.

Команды после разделителя. Клавиша, показанная справа от команды, делает то же с клавиатуры (см. Сочетания клавиш):

КомандаЧто он делает
ПерейтиТолько в структуре. Прокручивает документ к элементу и переводит на него фокус (Enter на записи структуры).
ОткрытиеОткрывает представление элемента.
Переименовать…Меняет имя. F2 на элементе документа в фокусе изменяет имя на месте.
Добавить {class} послеДобавляет элемент текущего класса после этого, как + После (⌘↵ / Ctrl↵).
Добавить дочерний {class}Добавляет элемент текущего класса под этим, как + Дочерний (⌥⌘↵ / Ctrl+Alt↵).
Сдвинуть вправо, Сдвинуть влевоКак ⇥ и ⇤ на панели инструментов (⌥⇧→ / Alt+Shift+→ и ⌥⇧← / Alt+Shift+←).
Переместить вверх, Переместить внизКак ↑ и ↓ на панели инструментов (⌥ / Alt+↑ и ⌥ / Alt+↓).
Статус ▸, Приоритет ▸Задаёт атрибут; текущее значение отмечено.
Связать с ▸Сначала перечисляет связи, чаще всего используемые для класса, затем Все связи ▸ со всеми связями, которые допускает класс. Выбор открывает средство выбора целевых сущностей.
Показать на диаграмме ▸Перечисляет типы диаграмм, которые могут показать элемент; выбор открывает диаграмму.
Копировать ссылкуКопирует ссылку на представление элемента.
Копировать номерКопирует номер элемента.
Открыть в ▸Представление элемента, История…, диаграммы, которые могут показать элемент (иерархии, древовидная, Spider, Action, Asset, Risk, времени), Матрица прослеживаемости, Качество требований и Функциональный анализ.
Переместить внутрь ▸Список с фильтрацией по вводу из элементов, которые могут содержать этот, с отступами в порядке документа, а также Верхний уровень документа, если у элемента есть родитель. Дочерние элементы перемещаются вместе с ним.
Разделить на несколько элементов…См. Разделение на несколько элементов.
Изменить класс…Открывает Сменить класс (тот же диалог, что и в базе данных; см. Модель и база данных).
Перенумеровать отсюда…Открывает Перенумерация для этого элемента, следующих за ним соседних элементов и их дочерних.
Задать атрибут в этой ветви…См. Задание атрибута в ветви.
Заблокировать / РазблокироватьБлокирует элемент от правок или разблокирует его.
Убрать из этого документаИсключает элемент и его дочерние из документа (Delete). Сущности остаются в проекте; сообщение предлагает Отменить и Удалить элемент….
Удалить элемент…Удаляет элемент и его дочерние после подтверждения (⇧Delete / Shift+Delete).

Каждая команда отменяется одним нажатием “Отменить”. Неприменимые команды неактивны, а их подсказка указывает причину:

  • В базовой линии или при доступе только для просмотра работают только Перейти, Открыть, Показать на диаграмме ▸, Копировать ссылку и Копировать номер. В базовой линии предложения и действия ✦ ИИ тоже неактивны.
  • У заблокированного элемента неактивны Переименовать…, Status ▸, Priority ▸, Связать с ▸, перемещения и Удалить элемент….
  • Пока активен фильтр или сортировка, добавление и перемещение неактивны (“Сначала сбросьте фильтр или сортировку”).
  • Команды, которые сдвинули бы элемент за начало или конец его уровня, неактивны (например, Переместить вверх у первого элемента).

Выбрано несколько элементов. Правый щелчок по элементу выделения действует на все выбранные элементы. Меню показывает Выбрано: N и предлагает пакетные действия ✦ (✦ Проверить с ИИ (n требований)…, ✦ Переписать (n) ▸, ✦ Сгенерировать тестовые случаи (n)…, ✦ Спросить ИИ об этих (n)…, ✦ Предложить трассы (n)…; см. ИИ для нескольких выбранных элементов), Задать Status ▸, Задать Priority ▸, Добавить в документ ▸, Убрать n из этого документа и Удалить n элементов… (после подтверждения; дочерние элементы выбранных удаляются вместе с ними). Команды для одного элемента (Перейти, Открыть, Переименовать…, добавление, отступ и перемещение) остаются в списке, но неактивны с причиной “Действует на один элемент”. Каждая команда — один шаг отмены. Правый щелчок по элементу вне выделения делает его единственным выбранным.

Описание и любое редактируемое поле сохраняют собственное меню браузера, чтобы там можно было копировать, вставлять и проверять орфографию. Правый щелчок с ⌥ / Alt показывает меню браузера где угодно.

Быстрое добавление

Быстрое добавление позволяет вводить требования подряд, не используя панель инструментов. Строка под документом содержит Быстрое добавление, список разделов, текстовое поле и Добавить. Список разделов предлагает Конец документа и Под {number name} для каждого раздела верхнего уровня.

Введите требование и нажмите Enter или Добавить. Новый элемент получает:

  • Текущий класс.
  • Текст в качестве описания.
  • Имя из первых слов после “shall”, “must”, “will” или “should”: до пяти слов, каждое с заглавной буквы.

Поле принимает до 2000 символов. Пока включён фильтр или сортировка, в поле написано “Сбросьте фильтр или сортировку, чтобы добавлять сущности”.

Инспектор

Выбранный элемент открывается в инспекторе справа, с полной панелью сущности (см. Модель и база данных).

  • В документе связи decomposed by и decomposes там доступны только для чтения, потому что ими управляет структура.
  • × в заголовке (Esc) снимает выбор. Вид ▾ → Свернуть дочерние сворачивает разделы под выбранным элементом.
  • Заблокированные элементы открываются только для чтения.

Добавление элементов

Новые элементы

  • + Новый {Class} добавляет в конец.
  • + После добавляет после выбранного элемента.
  • + Дочерний добавляет последний дочерний элемент выбранного, и родитель разворачивается.
  • Без выбора + После и + Дочерний добавляют в конец.

Новый элемент получает имя “New {Class}”. Он выбран, и его имя открыто для правки.

Другие классы

Другой класс… открывает Добавить элемент в документ с полями Класс (любой класс) и Имя. Используйте его для элементов, не являющихся Statement, например описания Asset или Test Case в плане испытаний.

Структурированные документы с Heading

Heading — это раздел документа (подход структурированных артефактов LML 2.0). Используйте Heading, когда раздел смешивает классы, например требования, действия и риски, или когда одно и то же требование входит в несколько документов.

  1. Выберите Заголовок в меню классов (+ Создать ▾, + После ▾ или + Дочерний ▾). Для Heading верхнего уровня документ является его source of; под другим Heading это нумерованный подраздел.
  2. Выберите Heading и используйте + Дочерний ▾, чтобы добавить содержимое: новый элемент любого класса или Добавить существующий элемент…. Heading contains этот элемент.
  3. Содержимое сохраняет собственный номер: добавление, перемещение и Перенумеровать… нумеруют Heading, а номера содержимого оставляют как есть, поэтому требование, например RQ.CLN.1, выглядит одинаково в каждом документе. Содержимое раздела перечисляется перед подразделами.

Перемещение содержимого к другому Heading (перетаскивание, Переместить внутрь ▸) переносит его связь contains. Проверки модели считают требование, которое содержит Heading, размещённым в документе.

Чтобы зафиксировать происхождение требования, свяжите его с исходным Artifact связью originated by (инспектор → Связи; Artifact перечисляет его под originates). Проект, созданный до появления Heading, сохраняет свою схему; Схема → Добавить новые встроенные… добавляет Heading, contains и originates.

Пример в демо CubeSat EO-1: раздел 7 Applicable Documents документа EO-1 System Requirements Specification — это Heading. Его содержимое — два стандарта проекта, которые сохраняют номера STD-1 и STD-2. STD-1 originates требование 3.4 Bus Regulation, а STD-2 originates 5.2 UHF Command Uplink.

Существующие сущности

Добавить существующий элемент… открывает средство выбора сущностей. Оно не включает сам документ и его текущие элементы. Сущность добавляется со всей своей декомпозицией. Если она приносит дочерние элементы, уведомление сообщает “Добавлено {entity} с N дочерними сущностями”.

Реструктуризация

Отступ, выступ и перемещение

  • Сдвинуть вправо делает элемент последним дочерним соседа выше. Первый элемент группы сдвинуть вправо нельзя.
  • Сдвинуть влево делает элемент следующим соседом его родителя.
  • Переместить вверх/вниз меняет элемент местами с соседом. Заблокированные элементы и заблокированные соседи не перемещаются.
  • Если перемещение невозможно, уведомление сообщает “Выбранный элемент нельзя переместить дальше в эту сторону.”

Перетаскивание

Перетаскивайте на панели Структура. Список прокручивается, когда вы тянете у его верхнего или нижнего края. Результат зависит от места сброса:

  • Верхние 28 % строки: элемент встаёт перед ней.
  • Нижние 28 % строки: элемент встаёт после неё.
  • Середина строки: элемент становится её дочерним.
  • Имя документа вверху: элемент становится элементом верхнего уровня в конце.

Перемещение под элемент

Щёлкните элемент правой кнопкой и выберите Переместить внутрь ▸. Список содержит элементы, которые могут принять его как дочерний, с отступами в порядке документа, а также Верхний уровень документа, если у элемента есть родитель. Введите текст для фильтрации списка, затем выберите нового родителя. Дочерние элементы перемещаются вместе с ним; уведомление сообщает “Перемещено: {item}”.

Список не включает собственное поддерево элемента, его текущего родителя, заблокированные элементы и родителей, которых не допускает схема. Если перемещение не удалось, сообщение гласит “Элемент нельзя переместить туда: новый родитель находится внутри него или элемент заблокирован. Выберите другого родителя или разблокируйте элемент.”

Нумерация

Автоматическая перенумерация

Перенумеровывать автоматически после добавления или перемещения элементов по умолчанию включено; изменить это можно в Писать ▾ → Перенумеровать…. Пока параметр включён, следующие действия перенумеровывают затронутую группу соседних элементов и всех потомков: добавление, перемещение, сдвиг вправо, сдвиг влево, удаление и разделение.

  • Элементы верхнего уровня получают шаблон номера документа с порядковым номером. Он начинается с первого номера документа: 1, если не изменён в Перенумеровать….
  • Дочерние элементы получают номер родителя, точку и порядковый номер (3, 3.1, 3.1.1).
  • Заблокированные элементы и записи глоссария (элементы с меткой Acronym, номер которых — сам термин) сохраняют свои номера, но по-прежнему занимают позицию.

При выключенном параметре:

  • Новый элемент получает номер, следующий за номером элемента перед ним. Первый дочерний элемент получает номер родителя плюс .1.
  • Существующие номера не меняются.
  • Перемещение элемента перенумеровывает только перемещённое поддерево.
  • Перемещение вверх/вниз меняет два номера местами.

Правила следующего номера

Чтобы продолжить последовательность, Holarch увеличивает последнюю часть предыдущего номера. Разделители и завершающие точка, двоеточие или скобка сохраняются.

  • Цифры: 1.9 → 1.10, 2. → 3.
  • Буквы: a → b, z → aa, Z → AA, Appendix A → Appendix B
  • Римские числа из двух и более букв: IV → V, IX → X. Одна буква считается буквой (I → J).
  • Ко всему остальному добавляется .1.

Перенумерация

Писать ▾ → Перенумеровать… перенумеровывает весь документ за один шаг. Перенумеровать отсюда… в контекстном меню элемента перенумеровывает этот элемент, следующие за ним соседние и всех их дочерних.

В диалоге есть:

  • Шаблон номера: {n} — позиция, а {n:3} дополняет её до трёх цифр. SYS-{n:3} даёт SYS-001, SYS-002; их дочерние нумеруются под ними: SYS-001.1, SYS-001.2. Шаблон без {n} получает номер в конце. При вызове от элемента шаблон и первый номер заполняются по его номеру.
  • Первый номер (только цифры). Другой ввод показывает “Введите первый номер цифрами, например 1.”
  • Таблица предпросмотра со столбцами Элемент, Текущий и Новый (изменённые номера выделены; до 400 строк) и счётчик вроде “Изменится номеров: 12 из 40.”
  • Перенумеровывать автоматически после добавления или перемещения элементов (только для всего документа).
  • Примечание “Заблокированные элементы сохраняют свои номера. Одно нажатие «Отменить» отменяет всю перенумерацию.” Записи глоссария тоже сохраняют свои.
  • Перенумеровать. Уведомление сообщает “Номера документа обновлены”.

Запуск для всего документа сохраняет шаблон и первый номер вместе с документом. Последующая автоматическая перенумерация использует их.

Нумерация документа (метаномера)

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

Включите её через Поставка ▾ → Настройка поставки… → Нумерация → Номера документа (хранятся только в этом документе). Номера модели (собственные номера элементов) выключает её.

  • При включении текущий номер каждого элемента копируется в документ.
  • С этого момента правка номеров меняет только этот документ.
  • Пока нумерация включена, штамп показывает “· нумерация по документу”.
  • Экспорт и отчёты используют номера документа.

Шаблоны

Шаблоны берутся из четырёх мест. Новый документ и Использовать шаблон перечисляют их в таком порядке, сначала шаблоны этого типа документа:

ГруппаГде хранитсяКто может добавить или изменить
Шаблоны организации: {name}На серверах Holarch (размещённых или собственных), для организацииАдминистраторы организации
Шаблоны проектаВ файле проекта; их видит каждый участник проектаВладельцы проекта (в настольном приложении — любой, кто открывает проект)
Встроенные шаблоныВ HolarchНикто
Сохранено в этом браузереТолько в этом браузере (шаблоны, сохранённые до версии 1.8.0)Импортируйте их в проект

Встроенные шаблоны

У каждого встроенного шаблона есть нумерованные разделы с начальными таблицами (например, таблицы Revision History и Approvals). С Включить рекомендации по написанию каждый раздел также начинается с краткого руководства по написанию.

“Новый документ” показывает число разделов каждого шаблона, например “39 sections” для Requirements Specification.

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

Многие разделы содержат динамические блоки, которые обновляются из модели при каждом показе или экспорте документа:

БлокВ
VCRM, VCRM по уровням, RVTM и RTM собственных требований документаСпецификации требований (разделы Verification и Traceability)
VCRM и RVTM всего проектаTest Plan, Verification and Validation Plan, Test Procedure, Test Report
Матрица интерфейсов и список каналовInterface Control Document, Architecture Description
Матрица распределения (функции по компонентам)Concept Definition, Architecture Description
Утверждения с меткой AcronymКаждый раздел Acronyms
Артефакты с меткой ReferenceКаждый раздел References
Риски; артефакты Trade StudyRisk Management Plan; Trade Study Report

Матрица, охватывающая “этот документ”, указывает на новый документ. Для Test Report добавьте результаты тестового цикла через Вставить ▸ Матрица… ▸ Test Report и выберите тестовый набор и цикл.

Сохранение документа как шаблона

Сохраните структуру документа как шаблон, чтобы начинать с него новые документы.

  1. Выберите Писать ▾ → Шаблоны ▸ Сохранить как шаблон….

    Откроется Сохранить {Type} как шаблон.

  2. Введите Имя шаблона.
  3. В поле Сохранить в выберите:
    • Этот проект: шаблоном может пользоваться каждый участник проекта. Этот вариант видят только владельцы проекта.
    • Организация: {name} (серверы Holarch, администраторы организации): шаблоном может пользоваться каждый участник организации. Отметьте Сделать шаблоном организации по умолчанию для {Type}, чтобы он был выбран заранее в “Новый документ”.
  4. Отметьте Включить файлы и изображения, если шаблон должен их сохранить.
  5. Нажмите Сохранить.

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

Если вы не можете сохранить ни один из видов, диалог сообщает об этом: обратитесь к владельцу проекта или администратору организации.

Управление шаблонами

Писать ▾ → Шаблоны ▸ Управлять шаблонами… перечисляет шаблоны проекта. Владельцы могут Переименовать и Убрать их; отмена восстанавливает убранный шаблон. Документы, созданные из шаблона, не меняются.

Администраторы организации управляют шаблонами организации в разделе Настройки организации → Шаблоны документов: откройте организацию и используйте Шаблоны документов, чтобы переименовать шаблон, включить или выключить По умолчанию (один шаблон по умолчанию на тип документа) или удалить его.

Шаблоны, сохранённые в этом браузере

До версии 1.8.0 пользовательские шаблоны сохранялись в браузере. Когда владелец проекта впервые открывает список шаблонов, Holarch предлагает скопировать их в проект: Импортировать в проект или Не сейчас. До тех пор они перечислены в разделе Сохранено в этом браузере. В Управлять шаблонами… для них есть Импортировать в проект и Убрать из браузера.

Применение шаблона к существующему документу

Писать ▾ → Шаблоны ▸ Применить шаблон… открывает Использовать шаблон с полями Тип документа, Шаблон, Сохранить этот документ как шаблон… и Управлять шаблонами….

Применить добавляет разделы шаблона с их номерами и вложенностью в конец документа. Уведомление сообщает “Добавлено N разделов.” Отмена удаляет их.

Редактор форматированного текста

Редактор форматированного текста изменяет описания с форматированием, таблицами, изображениями и динамическим содержимым. Щёлкните описание (или описание документа), чтобы изменить его. С клавиатуры перейдите к описанию клавишей Tab и нажмите Enter или F2; программы чтения с экрана объявляют его как текстовое поле с именем по его элементу (“Описание 1.2 Power Budget”).

Редактор открывается на месте с панелью инструментов, счётчиком слов и символов (“слов: N · символов: N”) и подсказкой “⌘↩ / Ctrl+Enter — сохранить · Esc — отменить · Tab — выйти”.

  • Чтобы сохранить, нажмите ⌘↵ / Ctrl↵, ✓, щёлкните вне редактора или нажмите Tab, чтобы выйти из него.
  • Чтобы отменить, нажмите Esc. Фокус возвращается к описанию.
  • Каждое сохранение отменяется одним нажатием “Отменить”.
  • Tab никогда не создаёт отступ, поэтому не может запереть вас в редакторе. Отступы списков делайте с помощью ⌘ / Ctrl+] / ⌘ / Ctrl+[ или ⇤ / ⇥.

Панель инструментов

КнопкаЧто он делает
+Меню вставки: ✦ Написать с ИИ…, Изображение…, Замещающий текст… (если в тексте есть изображения), Таблица…, Блок кода, Линия, Ссылка…, Ссылка на документ…, Файл…, Диаграмма…, Динамическое значение…, Количество или сумма…, Динамическая таблица…, Матрица…, Перекрёстная ссылка…, Символ… и Обновить рисунки диаграмм, если в тексте есть изображения диаграмм
✦Текстовые инструменты ИИ (см. ниже)
¶ ▾Стиль абзаца: Текст, от Заголовок 1 до Заголовок 4, Цитата, Блок кода
Ж / К / ЧПолужирный (⌘B / Ctrl+B), курсив (⌘I / Ctrl+I), подчёркнутый (⌘U / Ctrl+U)
⋯Подчёркнутый (⌘U / Ctrl+U), Зачёркнутый, Надстрочный, Подстрочный, Встроенный код, Выделение цветом, Очистить форматирование (⌘⇧M / Ctrl+Shift+M)
• / 1.Маркированный список (⌘⇧8 / Ctrl+Shift+8) / нумерованный список (⌘⇧7 / Ctrl+Shift+7)
⇤ / ⇥Уменьшить отступ (⌘[) / увеличить отступ (⌘])
≡ ▾Выравнивание: По левому краю, По центру, По правому краю, По ширине
▦Вставить таблицу… и, внутри таблицы, операции с таблицей
🔗Ссылка (⌘K / Ctrl+K)
AОбразцы Цвет текста и Фон (по десять цветов) и Убрать цвет
AaШрифт (Arial, Brush Script MT, Comic Sans MS, Garamond, Georgia, Helvetica, Impact, monospace, Times New Roman) и Размер (от 10 до 60 px) для выделенного фрагмента
↶ / ↷Отменить (⌘Z / Ctrl+Z) / повторить (⇧⌘Z / Ctrl+Shift+Z) внутри редактора
</>Исходный код HTML (⌘/ / Ctrl+/); при возврате исходный код очищается
⤢Полноэкранный режим; Esc сначала выходит из полноэкранного режима
✓Сохранить (⌘↵ / Ctrl↵)

Шрифту, размеру и стилям, оборачивающим выделение, нужно выделение. Без него уведомление сообщает “Сначала выделите текст.”

Таблицы

Вставить таблицу запрашивает Строки (по умолчанию 2), Столбцы (по умолчанию 3) и Строка заголовков (включена). Tab и Shift+Tab перемещают между ячейками. Tab в последней ячейке (или Shift+Tab в первой) выходит из редактора.

Внутри таблицы нажмите ▦ или щёлкните ячейку правой кнопкой, чтобы открыть операции с таблицей:

  • Добавить строку выше, Добавить строку ниже, Добавить столбец слева, Добавить столбец справа.
  • Добавить строку заголовков, Добавить подпись, Объединить с ячейкой справа.
  • Удалить строку, Удалить столбец, Убрать строку заголовков, Убрать подпись, Удалить таблицу.

Изображения и файлы

  • Изображение… вставляет файл изображения как рисунок. Диалог Вставить изображение запрашивает Замещающий текст (что показано на изображении) или Декоративное (замещающий текст не нужен) для изображения, не несущего информации.
  • Изображение можно также вставить из буфера или перетащить файл изображения в редактор. Такие изображения появляются без замещающего текста; уведомление сообщает “Изображение добавлено без замещающего текста. Добавьте его через меню + (Замещающий текст…).”
  • Вставка адреса изображения (заканчивающегося на .png, .jpg, .jpeg, .gif или .webp) вставляет само изображение.
  • Изображения больше 4000 px по длинной стороне уменьшаются. Уведомление сообщает “Изображение уменьшено до W × H px (предел — 4000 px по длинной стороне).”
  • Файл изображения больше предела на файл перерисовывается шириной 1600 px в формате JPEG. Если он всё ещё слишком велик, уведомление сообщает “Изображение превышает предел N МБ.”
  • Файл… прикрепляет любой файл как ссылку для скачивания со значком его типа. Файлы больше предела показывают “Файл превышает предел N МБ.”

Замещающий текст

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

  • + → Замещающий текст… перечисляет все изображения в тексте с их замещающим текстом и флажком Декоративное. Он предупреждает, если у изображения нет замещающего текста или замещающий текст — имя файла.
  • Дважды щёлкните изображение или щёлкните его правой кнопкой и выберите Изменить замещающий текст…, чтобы изменить только его.
  • Изображения диаграмм (Диаграмма…) берут замещающий текст из подписи: тип диаграммы и имя сущности.
  • Вывод Word записывает замещающий текст в описание каждого изображения. Декоративное изображение помечается как декоративное.
  • Ссылка… (Вставить ссылку) принимает URL и Текст. Адреса без http:, https:, mailto: или # получают https://. Ссылки открываются в новой вкладке.
  • Ссылка на документ… (Вставить ссылку на документ) ссылается на другой документ. Она принимает Документ, Версия (Текущая или Базовая линия: {name}) и Текст.
    • В выводе Word документы, связанные таким образом, можно добавить как приложения.
    • Если других документов нет, уведомление сообщает “В этом проекте нет других документов. Сначала создайте документ.”

Динамическое содержимое

Динамическое содержимое остаётся актуальным относительно модели везде, где показан текст: в документе, в инспекторе, в экспорте и в поиске.

  • Диаграмма… (Вставить диаграмму): выберите Тип диаграммы и сущность (или доску или рамку). Вставляется изображение диаграммы с подписью, связанное с диаграммой.
    • Изображение динамическое. Когда модель меняется, документ через мгновение показывает новое изображение, а Word и другие виды экспорта отрисовывают его заново.
    • Чтобы сохранить текущее изображение, дважды щёлкните рисунок в редакторе (Рисунок диаграммы) и выключите Обновлять изображение при изменении модели. Тогда рисунок становится снимком.
    • Обновить рисунки диаграмм (в +) сразу перерисовывает все динамические рисунки в тексте.
    • Если сущность диаграммы удалена, рисунок сохраняет последнее изображение.
  • Динамическое значение…: выберите сущность и Атрибут. Редактор показывает его “Динамическое значение”. Чтобы изменить атрибут, дважды щёлкните динамическое значение (Изменить динамическое значение).
  • Количество или сумма… вставляет число, пересчитываемое по модели, — для краткого обзора или строки статуса вроде “12 of 40 requirements are verified” (два подсчёта). Его поля:
    • Запрос: какие сущности считать, например class:Requirement AND Requirement:"Status=Approved". См. синтаксис поиска.
    • Область: Весь проект, этот документ или другой документ. Сборник в качестве области охватывает все свои части.
    • Функция: Количество, Сумма, Среднее, Минимум или Максимум. Все, кроме “Количество”, запрашивают Числовой атрибут, например Amount у Cost. Если суммировать нечего, значение — N/A.
    • Текущее значение. Чтобы позже изменить подсчёт, дважды щёлкните его.
  • Матрица… вставляет динамическую RTM, RVTM, VCRM, матрицу распределения или другую матрицу. См. Генерация документов.
  • Динамическая таблица… вставляет таблицу сущностей по запросу. Строки пересчитываются при каждом показе или экспорте текста. Её поля:
    • Запрос, например class:Requirement AND label:"Functional Requirement". По умолчанию — order:modified-. См. синтаксис поиска.
    • Область: Весь проект, этот документ или другой документ или сборник.
    • Столбцы (по порядку): по умолчанию Number, Name. + Добавить атрибут… добавляет столбец атрибута. + Добавить столбец связи… добавляет столбец со связанными сущностями, например Verified by.
    • Предел: по умолчанию 10. Все строки перечисляет все совпадения.
    • Предпросмотр до 50 строк.
    • Чтобы позже изменить динамическую таблицу, дважды щёлкните её.
  • Диапазон электронной таблицы… вставляет ячейки электронной таблицы как таблицу или как график выбранного типа (или один из собственных графиков листа) с подписью. Выберите электронную таблицу, лист и диапазон и при желании общее представление, которому следовать. Таблица и график показывают текущие значения и обновляются при изменении ячеек; Word и другие виды экспорта используют значения на момент экспорта. Если диапазон удалён, таблица сохраняет последние строки и помечается как отсутствующая.
  • Перекрёстная ссылка… (Вставить перекрёстную ссылку) ссылается на часть открытого документа по её текущему номеру:
    • Раздел или элемент показывает номер и имя элемента, например “3.2 Frost Warning”. Другая сущность… выбирает сущность вне документа.
    • Рисунок и Таблица перечисляют рисунки и таблицы документа, у которых есть подпись, в виде “Рисунок 2” или “Таблица 1”. Если у выбранного объекта ещё нет ключа ссылки, он добавляется.
    • Текст следует за перенумерацией. В выводе Word перекрёстные ссылки становятся полями, которые Word обновляет номерами подписей. Перекрёстная ссылка, цель которой удалена, сохраняет свой текст и помечается.
  • Символ… вставляет один из символов: ± ° µ Ω ≈ ≠ ≤ ≥ × ÷ √ ∞ ∑ π Δ, стрелки, • … — –, © ® ™ § ¶, € £ ¥ ¢, ½ ¼ ¾ ² ³, ✓ ✗.

Текстовые инструменты ИИ

✦ переписывает выделенный фрагмент или, если ничего не выделено, текущий абзац. Если работать не с чем, уведомление сообщает “Нет текста для переформулировки.”

Инструменты:

  • Улучшить формулировку, Упростить, Исправить орфографию и грамматику, Сократить, Добавить подробности, Закончить предложение.
  • Переписать в другом тоне…: академичный, напористый, непринуждённый, уверенный, конструктивный, сочувственный, воодушевляющий, беглый, официальный, дружелюбный, вдохновляющий, профессиональный.
  • Перевести… и Перевести весь текст…: арабский, китайский, английский, французский, немецкий, греческий, итальянский, японский, корейский, португальский, русский, испанский, шведский, украинский.
  • Написать с ИИ….

Предпросмотр показывает текущий вариант, предложенный и изменения. Выберите Заменить, Повторить или Отбросить.

Вставка

Вставленный форматированный текст сохраняет структуру: заголовки, списки, таблицы и ссылки. Он теряет классы, встроенные стили (кроме ячеек таблиц) и разметку Office. Скрипты, фреймы и небезопасные ссылки удаляются из любого форматированного текста.

Сочетания клавиш форматированного текста

КлавишиДействие
⌘↵ / Ctrl↵Сохранить и закрыть
EscОтменить (или выйти из полноэкранного режима)
⌘B / Ctrl+B / ⌘I / Ctrl+I / ⌘U / Ctrl+UПолужирный / курсив / подчёркнутый
⌘K / Ctrl+KСвязь
⌘⇧7 / Ctrl+Shift+7 / ⌘⇧8 / Ctrl+Shift+8Нумерованный / маркированный список
⌘] / ⌘[Увеличить / уменьшить отступ
Tab / Shift+TabСледующая / предыдущая ячейка таблицы; в остальных местах — выйти из редактора (с сохранением)
⌘⇧M / Ctrl+Shift+MУбрать форматирование
⌥⌘0 / Ctrl+Alt+0Абзац текста
От ⌥⌘1 / Ctrl+Alt+1 до ⌥⌘4 / Ctrl+Alt+4Заголовок 1 — заголовок 4
⌘/ / Ctrl+/Исходный код HTML
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZОтменить / повторить в редакторе

Поиск в документе

Нажмите Найти или ⌘F / Ctrl+F, чтобы искать в документе. Поле поиска показывает “n из m”.

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

  • Enter или ▼ переходит к следующему совпадению.
  • Shift+Enter или ▲ переходит к предыдущему совпадению.
  • Esc очищает текст, а × закрывает поле.

Свёрнутые разделы раскрываются, чтобы показать совпадение. Совпадающие строки подсвечены, а текущая отмечена.

Найти и заменить

Писать ▾ → Найти и заменить… открывает Найти и заменить. В нём есть:

  • Найти и Заменить.
  • Поля для поиска: Имя, Номер и Описание. “Номер” по умолчанию выключен.
  • С учётом регистра и Только слова целиком.

Строка под полями сообщает “Совпадает сущностей: N (заблокированные пропускаются).” Заменить все меняет все совпадения в элементах документа, и одно нажатие “Отменить” возвращает всё назад. Уведомление сообщает “Обновлено сущностей: N” или “Совпадений нет”. В форматированном тексте меняется только текст: форматирование, ссылки и обозначения сохраняются.

Меню “Писать”

Писать ▾ содержит команды, которые добавляют и изменяют содержимое. Команды добавления элементов неактивны в базовой линии, при доступе только для просмотра и пока включён фильтр или сортировка; подсказка указывает причину.

ПредметЧто он делает
Добавить элемент ▸Классы Statement и Другой класс…. Добавляет элемент после выбранного или, если ничего не выбрано, в конец. Выбранный класс становится текущим.
Добавить существующий элемент…См. Существующие сущности.
Вставить ▸Динамическое содержимое в описание выбранного элемента: Динамическое значение…, Количество или сумма…, Динамическая таблица…, Матрица…, Изображение диаграммы…, Диапазон электронной таблицы… и Перекрёстная ссылка…. Редактор описания открывается в конце текста с выбранным диалогом (см. Динамическое содержимое). Неактивно, пока не выбран незаблокированный элемент (“Сначала выберите незаблокированный элемент”). В сборнике также предлагает Документ… и Сгенерированный раздел… (см. Сборники).
✦ Сгенерировать требования…Генератор ИИ — под выбранным элементом или для всего документа. Каждый результат показывается в предпросмотре до добавления.
✦ Сгенерировать дочерние требования…Если выбран Statement или требование — новые дочерние элементы для него.
✦ Сгенерировать риски…Если выбран элемент — риски для него.
✦ Сгенерировать тестовый случай…Если выбрано требование — тестовый случай, который его верифицирует.
✦ Подвести итог…Пишет элемент-резюме, который всегда стоит первым в документе и не имеет номера.
✦ Перевести…Переводит текст документа с предпросмотром.
Найти и заменить…См. Найти и заменить.
Перенумеровать…См. Перенумерация.
Шаблоны ▸Применить шаблон… (Применение шаблона), Сохранить как шаблон… (Сохранение документа как шаблона) и Управлять шаблонами… (Управление шаблонами).

Задание атрибута в ветви

Щёлкните элемент правой кнопкой и выберите Задать атрибут в этой ветви…, чтобы задать одно значение элементу и всем его потомкам. Выберите Добавить метку, Убрать метку или атрибут, затем значение. Диалог отмечает “Применяется к {item} и его потомкам (N). Заблокированные сущности пропускаются.” Уведомление сообщает “Обновлено сущностей: N (пропущено заблокированных: k)”.

Разделение на несколько элементов

Щёлкните элемент правой кнопкой и выберите Разделить на несколько элементов…, чтобы разбить составное требование на единичные. Диалог называется Разделить на несколько элементов: {item}.

  1. Выберите Разрезать по предложениям или Разрезать по абзацам, а также Новые элементы как его дочерние или Новые элементы после него.

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

  2. Или нажмите ✦ Предложить разделение, чтобы ИИ предложил единичные требования (до 20).
    • Строки, текст которых содержит веб-адрес, сначала не отмечены.
    • Если исходный элемент утверждён, входит в базовую линию или заблокирован, замена его текста — неотмеченный параметр, который нужно включить.
    • Сравнение показывает строку 1 относительно исходного текста.
  3. Измените имена и текст. Объединить соединяет часть со следующей.
  4. Снимите отметки с ненужных частей и нажмите Применить.

Часть 1 (“остаётся”) остаётся в исходном элементе. Каждая отмеченная часть становится новым элементом того же класса с теми же метками. Номера предлагаются автоматически; при включённой автоматической перенумерации они переназначаются после разделения. Одно нажатие “Отменить” отменяет всё разделение; уведомление сообщает “Разделено на элементы: N”.

Меню “Проверить”

Проверить ▾ перечисляет то, что требует внимания в этом документе, с числами справа:

ПредметЧто он делает
Проверить качествоПроверяет каждое требование документа, проходящее текущий фильтр, и открывает результаты. Если выбрано требование, пункт называется Проверить качество этого требования. Если требований нет: “В этом документе нет требований для проверки. Утверждения не оцениваются.”
Проверки модели для этого документа…Открывает Проверки модели для этого документа: результаты проверок модели для документа и его элементов (правило, элемент, результат) и динамическое содержимое, указывающее на отсутствующий объект. Щёлкните элемент, чтобы выбрать его. Если результатов нет: “Для этого документа нет результатов.” Открыть проверки модели открывает страницу для всего проекта.
Статус прослеживания…Показывает “Завершено: N из M” и открывает Статус прослеживания: требования, ещё не распределённые или не верифицированные, каждое со своей точкой и тем, чего не хватает (satisfied by, verified by). Щёлкните требование, чтобы выбрать его. Открыть RVTM открывает страницу RVTM. Показывается, когда в документе есть требования.
Ссылки для проверкиОткрывает “Ссылки для проверки” для этого документа.
Реестр TBD/TBRОткрывает реестр TBD/TBR для этого документа.
Найти аббревиатуры…См. Поиск аббревиатур.
КомментарииПоказывает число открытых комментариев и открывает их в инспекторе (см. Комментарии).

Статус прослеживания

Точка после значков каждого требования показывает его статус прослеживания:

  • Зелёная: требование satisfied by чем-то (распределено) и verified by чем-то.
  • Янтарная: одной из двух связей нет.
  • Красная: нет ни одной связи.

Наведите указатель на точку, чтобы увидеть статус и то, чего не хватает, например “Статус прослеживания: частично прослежено. Не хватает: нет связи verified by (не верифицировано).” Щёлкните её, чтобы открыть меню с элементами в разделах Удовлетворяется (распределение) и Verified by (щёлкните элемент, чтобы открыть его), Открыть в RVTM и Связать с ▸. У утверждений и других классов точки нет. В базовой линии точки показывают связи базовой линии. Выключите точки через Вид ▾ → Статус прослеживания.

Поиск сокращений

Проверить ▾ → Найти аббревиатуры… находит аббревиатуры в номерах, именах и описаниях документа и добавляет их в его раздел Glossary одним списком для проверки.

  • Аббревиатура — это две или более заглавных буквы, до восьми символов, и не только цифры.
  • Расшифровка берётся из существующей записи проекта или из слов рядом с термином, начальные буквы которых его образуют (“Concept of Operations” → CONOPS).
  • В каждой строке есть Оставить, Термин, Расшифровка и его Употребления (щёлкните “N употреблений”, чтобы увидеть каждое место). Примечание отмечает термины, которые уже “в глоссарии”, у которых “запись есть в проекте” или для которых “расшифровка не найдена”.
  • Термины с расшифровкой, которых ещё нет в глоссарии, сначала отмечены. Флажок в заголовке отмечает или снимает отметку со всех.
  • Связать каждое употребление в тексте с его записью в глоссарии (живое значение) (включено) превращает каждое употребление в описаниях в динамическое значение номера записи, связанное с записью.

Нажмите Добавить в глоссарий. Каждый отмеченный термин становится Statement с меткой Acronym, где Number = термин, а Name = расшифровка, в разделе верхнего уровня документа Glossary (используется существующий раздел с именем Glossary или Acronyms; иначе он добавляется в конец). Запись, уже имеющаяся в проекте, используется повторно, а не создаётся вторая. Одно нажатие “Отменить” возвращает всё назад. Если ничего не найдено, вы видите “В этом документе нет аббревиатур. Аббревиатуры — это слова из двух или более заглавных букв, например CONOPS.”; если ничего не отмечено — “Отметьте хотя бы один термин.” Перенумерация не трогает записи глоссария.

Меню “Поставка”

Поставка ▾ настраивает поставляемый документ и экспортирует его, с группировкой по виду вывода:

ПредметЧто он делает
Настройка поставки…Нумерация, титульная страница, колонтитул и блок подписей (см. Настройка поставки).
Параметры страницы…Гриф, обложка и номера страниц (см. Формат страницы).
Шаблон Word ▸Шаблоны Word, с ✔ у шаблона, который использует этот документ, и Редактировать шаблоны Word…. Выбор шаблона делает его шаблоном этого документа.
Версия ▸Сохранить базовую линию… и Сравнить версии… (см. Базовые линии).
Word: по одному пункту {template} (Word) на каждый шаблон WordСразу скачивает документ в формате Word с параметрами этого шаблона; у собственного шаблона документа указано “этот документ”. Из базовой линии выводится базовая линия.
Структура (Word)…Структура в виде заголовков, при желании с оглавлением.
Сравнение с правкой (Word)…См. Сравнение с правкой. Нужна базовая линия.
Excel: матрица прослеживаемости…Стандартная матрица в формате Excel, Word, CSV или веб-страницы (см. Генерация документов).
Изменения (Excel)…Изменения от базовой линии до более поздней или до текущей версии. Нужна базовая линия.
Обмен: требования (ReqIF)…, Данные документа (JSON)…Форматы обмена (см. Отчёты).
Печать или PDF…См. Печать / PDF.
Все виды экспорта…Все виды экспорта с их параметрами (см. Отчёты).

Шаблоны Word

Шаблон Word — это именованный набор параметров экспорта в Word и страницы. Он задаёт вид файла Word, а не содержимое (содержимое заполняют шаблоны документов; см. Шаблоны). Каждый документ использует один шаблон; по умолчанию — Specification. Выберите его в Поставка ▾ → Шаблон Word ▸.

Встроенные шаблоны:

ОбразецПараметры
СпецификацияОглавление до уровня 3, нумерованные подписи, списки рисунков и таблиц, история изменений и утверждения из базовых линий, связанные документы как приложения. Столбцы атрибутов, если документ их показывает.
Deliverable by ChapterКак Specification, но подписи нумеруются по главам (Рисунок 3-1), а заголовки внутри описаний попадают в оглавление.
Review CopyАльбомные страницы со столбцами атрибутов документа под каждым элементом; оглавление до уровня 2, без таблиц вводной части.
PlainЗаголовок, заголовки разделов и текст: без оглавления, номеров подписей и таблиц вводной части.

Все встроенные шаблоны используют страницы Letter.

Редактировать шаблоны Word… открывает Шаблоны Word. У встроенных шаблонов есть Копировать; копия становится шаблоном проекта, хранящимся в проекте для всех участников. Выберите шаблон проекта, чтобы изменить:

  • Имя, Размер страницы (Letter (8,5 × 11 дюймов) или A4 (210 × 297 мм)) и Ориентация (Книжная или Альбомная).
  • Оглавление (Нет, Уровень 1, Уровни 1–2, Уровни 1–3, Уровни 1–4, Все уровни) и Нумерация подписей (Рисунок 1, Таблица 1, По главам: Рисунок 3-1 или Выкл.).
  • Список рисунков и список таблиц (если есть подписи), Заголовки внутри описаний появляются в оглавлении, Столбцы атрибутов, показанные в документе, под каждым элементом, Связанные документы как приложения и История изменений и утверждения из базовых линий.
  • Удалить шаблон.

Нажмите Сохранить (одно нажатие “Отменить” отменяет это; уведомление сообщает “Шаблоны Word сохранены.”). Документ, шаблон которого удалён, возвращается к Specification.

Файлы Word компании

Шаблон проекта может содержать собственный файл Word вашей организации (.docx или .dotx, до 5 МБ). Тогда экспорт использует из файла:

  • Стили: шрифты, цвета, стили заголовков и основного текста. Стили, которых нет в файле (подписи, записи оглавления), добавляются; нумерация заголовков из файла отбрасывается, потому что заголовки нумерует Holarch.
  • Страницу: размер, ориентацию и поля. Выбор файла устанавливает в шаблоне Размер страницы и Ориентация в соответствии с ним.
  • Колонтитулы с их логотипами и номерами страниц. В каждый добавляется гриф проекта или документа.
  • Титульную страницу: содержимое файла до первого разрыва раздела или весь файл, если разрывов нет. Она заменяет титульную страницу Holarch.

На титульной странице и в колонтитулах заполняются следующие заполнители: {{Title}}, {{Type}}, {{Number}}, {{Version}}, {{Date}}, {{Project}}, {{Organization}}, {{Contract}}, {{CDRL}}, {{Prepared For}}, {{Prepared By}} и {{Baseline}}. Регистр и пробелы не важны. Другой текст в фигурных скобках остаётся как есть.

Чтобы добавить файл:

  1. Выберите Поставка ▾ → Шаблон Word ▸ → Редактировать шаблоны Word….
  2. Нажмите Выбрать… в строке Файл Word компании или выберите шаблон проекта и нажмите Выбрать… под Файл Word компании.
  3. Выберите файл. Нажмите Сохранить.

Заменить… меняет файл, а Убрать возвращает стили и титульную страницу Holarch. Файл, не являющийся документом Word, отклоняется с сообщением “Файл не является документом Word (.docx или .dotx).” Содержимое, обращающееся за пределы документа, не включается: связанные изображения, внедрённые объекты и элементы управления, а также поля INCLUDETEXT, INCLUDEPICTURE, DDE, LINK и IMPORT. Макросы никогда не читаются.

Страница шаблона также задаёт ширину режима Бумага: страницы Letter шириной 816 px, A4 — 794 px, в альбомной ориентации шире. В Все виды экспорта… → Документ (Word) параметры берутся из шаблона документа; Шаблон Word там заполняет их из другого шаблона, и их можно изменить для одного экспорта.

Меню “Вид”

Вид ▾ содержит прямые переключатели для этого документа:

  • Бумага (✔, когда включено): показывает документ страницами шириной страницы шаблона Word, без столбцов атрибутов. Requirements Documents открываются с выключенным режимом, остальные типы — с включённым.
  • Панель структуры: показывает или скрывает панель структуры.
  • Статус прослеживания: показывает или скрывает точки статуса прослеживания. По умолчанию включено.
  • Столбцы ▸ (неактивно в режиме бумаги): все атрибуты классов документа и поля элементов (Class, Number, Created On, Modified On, Labels), с ✔ у показанных столбцов. Выберите столбец, чтобы показать или скрыть его; новый столбец добавляется в конец. Столбцы по умолчанию восстанавливает Status, Verification Method и Оценка качества.
  • Свернуть все и, если что-то свёрнуто, Развернуть все.
  • Свернуть дочерние: сворачивает разделы под выбранным элементом (неактивно, пока не выбран элемент с подразделами).
  • Сбросить вид: сбрасывает сворачивание, фильтры, сортировку и поиск. Также показывает панель структуры со стандартной шириной, сбрасывает ширину столбцов и восстанавливает столбцы по умолчанию.
  • Открыть в ▸: открывает выбранный элемент или, если ничего не выбрано, документ в другом представлении: Представление элемента, История… (все записанные изменения, со сравнением по словам для каждого поля), диаграммы, которые могут его показать, Матрица прослеживаемости (документ как ось строк), Качество требований (в пределах документа) и Функциональный анализ.
  • Справка.

Щёлкните правой кнопкой заголовок столбца, чтобы выбрать Переместить влево, Переместить вправо или Скрыть столбец.

Столбцы запоминаются для каждого документа в этом браузере. Последний выбор служит отправной точкой для документов, которые вы ещё не настроили. Paper и Trace Status сохраняются вместе с документом. Положение горизонтальной прокрутки не меняется при выборе строки.

Базовые линии

Версия ▾ в штампе перечисляет Текущая версия, базовые линии этого документа и в разделе Базовые линии проекта базовые линии проекта (каждая с датой; ✔ отмечает показанную). В конце стоят Сохранить базовую линию… и Сравнить версии…. В Поставка ▾ → Версия ▸ есть те же две команды.

Создание базовой линии

  1. Нажмите Версия ▾ → Сохранить базовую линию… (недоступно, пока показана базовая линия: “Сначала вернитесь к текущей версии”).

    Сохранить базовую линию открывается с пояснением “Базовая линия сохраняет эту версию документа (его элементы, их атрибуты и связи), чтобы позже просмотреть, сравнить и восстановить её. Записи об утверждении датируются текущим моментом и впоследствии не редактируются.”

  2. Введите Имя (обязательно). По умолчанию: “{document} Baseline N”.
  3. В разделе Утверждения заполните по одной строке на каждого утверждающего: Имя, Роль и Заявление. Первая строка заполнена вашим именем. Заявление по умолчанию: “Утверждено к выпуску.”
  4. Нажмите + Добавить утверждающего, чтобы добавить строки, или ×, чтобы убрать строку. Строки без имени не учитываются.
  5. Нажмите Создать.

    Уведомление сообщает “Базовая линия сохранена”.

Просмотр базовой линии

Выберите базовую линию в Версия ▾. Баннер сообщает “Базовая линия “{name}”, только чтение, сохранена {date}” (с “· базовая линия проекта” для базовой линии проекта) и перечисляет утверждающих. Он предлагает:

  • К текущей версии: возвращает к рабочей копии.
  • Изменить (базовые линии документа): открывает Редактировать базовую линию. Переименуйте базовую линию или добавьте записи об утверждении в разделе Добавить утверждения. “Новые записи датируются текущим моментом и добавляются в список. Существующие записи изменить нельзя.”
  • Сравнить с текущей (базовые линии документа): открывает Сравнить версии от этой базовой линии.
  • Восстановить базовую линию: спрашивает “Заменить сущности, порядок и структуру этого документа базовой линией “{name}”? Сущности, добавленные с тех пор, убираются из документа (не удаляются). Действие можно отменить.”
    • Для базовой линии проекта открывается Заменить проект базовой линией: “Заменить весь проект базовой линией проекта “{name}”? Действие можно отменить.”
  • Удалить: спрашивает “Удалить базовую линию “{name}”?”

В базовой линии редактирование, быстрое добавление и инструменты структуры отключены, а в структуре показан 🔒. Поставка ▾ создаёт выходные файлы из базовой линии (“Экспорт (базовая линия “{name}”)”).

Динамическое содержимое в базовой линии показывает модель базовой линии на экране и в выходных файлах: динамические значения, количества и суммы, динамические таблицы, матрицы и перекрёстные ссылки вычисляются по снимку, а рисунки диаграмм сохраняют изображения, сохранённые с базовой линией. Базовая линия документа содержит документ, его элементы и сущности на расстоянии одной связи, поэтому количество или таблица в ней охватывает эти сущности; динамическое значение сущности вне базовой линии показывает её текущее значение.

Сравнение версий

Версия ▾ → Сравнить версии… открывает Сравнить версии. Сравнивается От (базовая линия) с До: более поздней базовой линией или Текущая версия. Без базовых линий показывается “У этого документа нет базовой линии. Сначала сохраните её.”

Показывается “N изменений” со столбцами Номер, Имя, Изменить тип, Поле и Изменение. Для изменённого текста Изменение показывает пословное сравнение.

Типы изменений:

  • Добавлено и Удалено.
  • Изменён: поле — Name, Number, Description, Class, Image или любой атрибут.
  • Метка добавлена и Метка удалена.
  • Связь добавлена, Связь удалена и Атрибут связи.

Изменения (Excel) скачивает сравнение со столбцами Number, Name, Class, Change Type, Field, Old Value и New Value. Исправления (Word) скачивает то же сравнение как документ Word с исправлениями (см. Исправления).

Отчёты

Поставка ▾ экспортирует документ в Word, PDF, электронные таблицы и другие форматы. Пункты {template} (Word) скачиваются сразу (см. Шаблоны Word); у каждого пункта Word под названием есть однострочное описание. Удалить документ… в конце меню удаляет документ, при желании вместе с разделами, которые не использует ни один другой документ (см. Список документов), а затем возвращает к списку. Структура (Word)…, Исправления (Word)…, Изменения (Excel)…, Требования (ReqIF)…, Данные документа (JSON)… и Печать или PDF… открывают диалог Экспорт с этим выбором; Все экспорты… открывает его с вашим последним выбором.

  1. Нажмите Поставка ▾ → Все экспорты….

    Открывается Экспорт.

  2. Выберите, что экспортировать, в Экспортировать как. Варианты называются “<содержимое> (<формат>)” и сгруппированы по виду вывода: Word, Excel, CSV, веб-страница, текст, обмен и печать.
  3. Задайте его параметры.
  4. Измените Имя файла (до 99 символов).
  5. Нажмите Экспорт.

Предпросмотр показывает первые 60 строк отчётов в виде электронных таблиц. Для других экспортов он показывает “Предпросмотр доступен только для экспорта электронных таблиц. Выберите экспорт в Excel.” Отчёты используют номера документа, а в базовой линии — её содержимое.

ОтчётВыходПараметры
Документ (Word)Документ в Word (см. Вывод в Word)Шаблон Word (шаблон документа; выбор другого заполняет из него параметры ниже), Добавить оглавление, Глубина оглавления от 1 до 6, Нумерация подписей (Рисунок 1, Таблица 1, По главам: Рисунок 3-1, Таблица 3-1 или Выкл.), Список рисунков и список таблиц (если в документе есть подписи), Заголовки внутри описаний появляются в оглавлении, Включить столбцы атрибутов, показанные в документе, Добавить связанные документы как приложения, Заполнить таблицы «История изменений» и «Утверждения» из базовых линий. Значения по умолчанию берутся из шаблона; для Specification: оглавление до уровня 3, простая нумерация подписей, списки, столбцы, если они показаны, приложения и таблицы базовых линий включены, заголовки выключены. Размер и ориентация страницы берутся из шаблона.
Изменения (Excel)Каждый добавленный, удалённый и изменённый элемент, атрибут и связь между двумя версиямиОт (базовая линия, сначала выбрана самая старая), До (Текущая версия или базовая линия); без базовой линии — “У этого документа нет базовой линии. Сначала сохраните её.”
Таблица (CSV)Одна строка на элементАтрибуты (в порядке столбцов) (по умолчанию Number, Name, Description и показанные столбцы; также любое Связь: {name} со списком связанных элементов), Сортировать по Иерархическая, Номер или Имя
Комментарии (Excel)Одна строка на каждый комментарий к документу и его элементам, с автором комментарияВключить класс, имя, номер и описание, Дата, Решено (всё включено)
Данные документа (JSON)Документ для повторного импортаНепосредственно связанные сущности (выкл.), Комментарии (вкл.), Базовые линии (выкл.), История (выкл.)
Структура (Word)Только заголовки, с нумерациейДобавить оглавление (выкл.)
Документ (Markdown)Документ в виде заголовков и текста Markdownнет
Документ (печать или PDF)Диалог печати браузера; выберите там “Сохранить как PDF”нет
Исправления (Word)Документ с исправлениями Word (см. Исправления)От базовой линии (последняя), Цель (более поздняя базовая линия или Текущая)
Замечания по качеству (Excel)Девять строк на требование (по одной на критерий) с сообщением и зелёным Yes или красным No, а в конце — “Report score”Другие атрибуты, Включить «Создано», «Изменено» и глобальный ID
Требования (ReqIF)ReqIF XML с иерархией и связями traced to, satisfied by, verified by, satisfies, verifies и traced from внутри документанет
RSM (Excel)Требование → элементы satisfied byАтрибуты требования (Number, Name), Атрибуты связанной сущности (Class, Number, Name, Description)
RTM (Excel)Требование → элементы traced toкак RSM
RVM (Excel)Требование → элементы verified byкак RSM
RVTM (Excel)Требование → верифицирующие Test Case, включая каждую строку документаАтрибуты требования (Number, Name, Description, Verification Method(s)), Атрибуты Test Case (Number, Name, Description, Status)
TVM (Excel)Test Case в документе → требования, которые они верифицируютАтрибуты Test Case (Number, Name, Status), Атрибуты требования (Number, Name, Description)
VCRM (Excel)Требования × методы верификации с отметкой XАтрибуты требования (Number, Name), Методы верификации (все)
Матрица прослеживаемости (Excel), (Word), (CSV), (HTML)Стандартная матрица документа или всего проекта (см. Генерация документов)Матрица, Область (Этот документ или Весь проект)

В матричных отчётах:

  • Требование без связанного элемента закрашивается красным. В VCRM красным закрашивается требование без метода.
  • Ячейки требования объединяются по его связанным строкам.
  • Две строки заголовка закреплены.

Вывод в Word

Документ (Word) создаёт файл Word в таком порядке:

  1. Титульная страница (если включено Титульная страница в параметрах страницы или Титульная страница в настройке поставки), иначе заголовок и строка курсивом с типом и “№ {number}”. Из базовой линии строка дополняется “Базовая линия: {name} ({date})”. Уведомление о грифе (параметры страницы) появляется в рамке под заголовком.
  2. История изменений (Версия, Дата, Автор, Изменения): одна строка на каждую базовую линию документа, от самой старой, до экспортируемой базовой линии.
    • Первая строка: “Исходная базовая линия”. Последующие строки: “N добавлено, N удалено, N изменено” или “Без изменений”.
    • Автор — создатель базовой линии или её утверждающие.
  3. Утверждения (Роль, Имя, Заявление, Дата) из последней (или экспортируемой) базовой линии. Если записей об утверждении нет, запланированные утверждающие из настройки поставки получают блок подписей: Роль, Имя, Подпись и Дата с пустыми строками для подписи.
  4. Описание документа, затем оглавление, Список рисунков и Список таблиц и разрыв страницы.
  5. Каждый элемент как заголовок Word с номером и именем, затем его описание. Стили Heading 1–Heading 6 следуют глубине; более глубокие уровни остаются на Heading 6. Таблица “Атрибут/Значение” перечисляет выбранные столбцы, у которых есть значение.
  6. Приложения: каждый документ, связанный встроенной ссылкой, начинается с новой страницы с “{document} Appendix” и своим содержимым на один уровень ниже.

Сгенерированные таблицы могут попадать в раздел, а не в начало. Так происходит, если в документе есть раздел с одним из этих имён (встроенные шаблоны их используют):

  • История изменений: “Revision History” или “Document Revision History”.
  • Утверждения: “Approvals”, “Approval”, “Sign-off”, “Signoff”, “Signatures” или “Signature”.

Подписи, списки и перекрёстные ссылки

  • Подписи рисунков (подпись изображения, рисунок диаграммы) выглядят как “Рисунок 1: {caption}” под изображением. Подписи таблиц (заголовок матричного блока, подпись таблицы) выглядят как “Таблица 1: {caption}” над таблицей.
  • По главам нумерует их по разделам верхнего уровня: “Рисунок 3-1” — первый рисунок в разделе 3. Таблицы без подписи не нумеруются.
  • Номера — это поля SEQ Word, а Список рисунков и Список таблиц — поля Word по подписям. Они появляются, только если в документе есть подписи рисунков или таблиц. Пока Word не обновит поля, списки показывают подписи без номеров страниц.
  • Каждый заголовок, подпись рисунка и подпись таблицы несёт закладку. Перекрёстная ссылка в описании становится полем REF Word на закладку, поэтому после обновления полей в Word она показывает текущий заголовок (“3.2 Frost Warning”) или метку (“Рисунок 2-1”). Перекрёстная ссылка на элемент, которого нет в экспортируемом документе, сохраняет свой текст.
  • Заголовки внутри описаний появляются в оглавлении превращает заголовки в описании в настоящие заголовки Word на один уровень ниже элемента. Если выключено, они остаются полужирными абзацами.

Настройка поставляемого документа

Поставка ▾ → Настройка поставки… хранит данные, которые обычно показывает контрактный поставляемый документ. Применить сохраняет их; ⌘Z / Ctrl+Z отменяет это за один шаг.

ПолеГде отображается
НумерацияНомера модели (собственные номера элементов) (по умолчанию) или Номера документа (хранятся только в этом документе) (см. Нумерация документа).
Титульная страницаВключает титульную страницу (тот же переключатель, что и Титульная страница в параметрах страницы).
Версия, ПодготовилТитульная страница и верхний колонтитул (те же поля, что в параметрах страницы).
Организация, Подготовлено для, Номер контракта, Пункт CDRL, Номер DIDТитульная страница. Пункт CDRL также появляется в нижнем колонтитуле.
ЛоготипВерх титульной страницы. PNG, JPEG или GIF, до 400 КБ.
Уведомление на титульной страницеРамка внизу титульной страницы, например заявление о распространении. Если пусто — уведомление о грифе из параметров страницы.
КолонтитулыВключены по умолчанию. Верхний колонтитул показывает “{number}, Version {version}” и заголовок; нижний — дату, “Page X of Y” и “CDRL {item}”. Нужен номер документа или версия.
Запланированные утверждающиеРоль и имя каждого утверждающего. Они получают строки для подписи, пока базовая линия не зафиксирует утверждения.

Номер документа — это поле № рядом с заголовком документа.

Формат страницы

  • Страница шаблона Word: US Letter или A4, книжная или альбомная, с верхним и нижним полями 1 дюйм и боковыми полями 0,875 дюйма.
  • Calibri 11 pt.
  • Настоящие стили заголовков, поэтому область навигации и оглавление Word работают.
  • Строки заголовков таблиц закрашены и повторяются на каждой странице.
  • Баннеры страницы (грифы) повторяются в верхнем и нижнем колонтитулах каждой страницы, включая титульную.
  • С титульной страницей файл состоит из трёх разделов: титульная страница (только баннеры, без колонтитула и номера страницы), вводная часть (история изменений, утверждения, описание, оглавление и списки, нумерация i, ii, iii) и основная часть (нумерация с 1; “Page X of Y” считает основную часть).
  • При открытии файла Word предлагает обновить поля. До этого оглавление показывает “Right-click and choose Update Field to build the table of contents.” (щёлкните правой кнопкой и выберите “Обновить поле”, чтобы построить оглавление).

Преобразование форматированного текста

  • Сохраняются: полужирный, курсив, подчёркивание, зачёркивание, верхний и нижний индекс, встроенный код (Consolas), выделение цветом, цвет текста и веб-ссылки.
  • Заголовки внутри описаний становятся полужирными абзацами или, с параметром выше, заголовками Word.
  • Списки становятся абзацами с отступом и “•” или “1.”.
  • Блоки кода становятся закрашенными строками моноширинного шрифта. Цитаты становятся курсивом с отступом.
  • Таблицы сохраняют объединённые столбцы и заливку заголовков.
  • Изображения PNG, JPEG и GIF встраиваются шириной примерно до 6,5 дюйма, с замещающим текстом в качестве описания изображения. Изображения SVG и WebP в файлы Word не включаются.

Исправления

Поставка ▾ → Исправления (Word)… записывает документ с исправлениями Word. Выберите От базовой линии и Цель (более позднюю базовую линию или Текущая). Исправления (Word) в Сравнить версии делает то же для двух показанных там версий.

  • Файл начинается с таблицы Сводка изменений: каждое изменение из отчёта об изменениях, включая атрибуты, метки и связи.
  • Затем следует документ в целевой версии: добавленный элемент — отслеживаемая вставка; удалённый элемент — отслеживаемое удаление, размещённое после предшествовавшего ему элемента; изменённое имя или описание показывает удалённые и вставленные слова.
  • Примите или отклоните изменения на вкладке Рецензирование Word. Изменённые описания отображаются простым текстом; неизменённые сохраняют форматирование.
  • Изменения приписываются создателю целевой базовой линии или, для Текущая, вам.

Печать или PDF… печатает страницу документа средствами браузера. Баннеры печатаются вверху и внизу каждой страницы. С колонтитулом (настройка поставки) “{number}, Version {version}” и заголовок повторяются вверху каждой страницы, а дата и пункт CDRL — внизу. В сборнике каждая часть начинается с новой страницы. Номера страниц, оглавление и нумерация подписей есть только в выводе Word.

Комментарии

Комментируйте элемент в его панели сущности в инспекторе (часть “Обсуждение”). Проверка ▾ → Комментарии или 💬 n открытых комментариев в штампе показывает комментарии в инспекторе:

  • Каждый комментарий к документу и его элементам, сгруппированный по элементам, с “(N открыто)”. Ответы показаны с отступом под комментарием, на который отвечают. Щёлкните имя элемента, чтобы выбрать его.
  • Показать решённые включает решённые комментарии.
  • У каждой ветки на первом комментарии есть Решить/Открыть снова, а у каждого комментария — × (удалить).
  • Чтобы прокомментировать сам документ, введите текст в Комментировать этот документ… и нажмите Добавить комментарий.
  • × вверху закрывает комментарии; при выборе элемента вместо них показывается его панель сущности.
  • Строка с нерешёнными комментариями показывает 💬 n; щёлкните его, чтобы открыть обсуждение элемента.
  • Решайте, открывайте снова и удаляйте комментарии в любом из этих мест.
  • Комментарии (Excel) в Все экспорты… собирает их.

См. Комментарии и рецензирование.

Сборники

Сборник объединяет другие документы. Новые сборники, созданные на странице Рецензирование или командой Создать пакет рецензирования, помечаются Пакет рецензирования; пакеты, созданные раньше, помечены Сборник и работают так же. См. Рецензирования.

Вставить документ… добавляет документ. Команда находится в Писать ▾ → Вставить ▸ и в меню + Создать ▾.

  • Перечисляются документы, ещё не включённые в сборник.
  • Вставленный документ появляется как элемент верхнего уровня, а его содержимое — под ним. Уведомление сообщает “Вставлено: {document}”.
  • Если других документов нет, показывается “Нет других документов для вставки.”

Сгенерированные разделы

Вставить сгенерированный раздел… (в Писать ▾ → Вставить ▸ и в меню + Создать ▾) добавляет часть, содержимое которой заново строится из модели при каждом показе или экспорте сборника.

СодержимоеЧто содержит часть
Матрица или Отчёт об испытаниях…Вставить открывает Вставить матрицу; выберите там матрицу (или отчёт об испытаниях) и её область. Область Сборник (все части) охватывает каждую часть. Оставьте Имя раздела пустым, чтобы использовать имя матрицы.
Список сокращенийТаблица утверждений с меткой Acronym (Number, Name), отсортированная по номеру.
Таблица запросаТаблица сущностей, соответствующих Запрос, с перечисленными вами Столбцы (имена атрибутов через запятую).

Часть получает номер после последней части, поэтому документы частей сохраняют свои номера. ⌘Z / Ctrl+Z убирает её за один шаг. Без имени показывается “Введите имя раздела.”; таблица запроса без запроса или столбцов показывает “Введите запрос и хотя бы один столбец.”

Сборник в Word

Экспорт сборника в Word экспортирует каждый элемент верхнего уровня как часть:

  • Заголовок части выглядит как “Part A: {document}” (Heading 1), со строкой с типом, номером и закреплённой базовой линией документа.
  • Номера разделов внутри части получают букву части: “A.1 Scope”, “B.1 Scope”. Ни один номер раздела не повторяется.
  • Каждая часть после первой начинается с новой страницы.
  • С подписями По главам рисунки в части B выглядят как “Figure B-1”.

Настройка поставки… в сборнике добавляет Части сборника:

НастройкаВарианты
Метки частейЧасть А, Часть Б, … (по умолчанию), Том 1, Том 2, …, Приложение А, Приложение Б, … или Нет меток частей
Номера разделовПо частям, с буквой или номером части (A.1, B.1) (по умолчанию), Сквозная по частям (1, 2, 3) или У каждого документа свои номера
Начинать каждую часть с новой страницыВключено по умолчанию
Титульная страница для каждой частиЗаголовок части и его строка на отдельной странице
Экспортировать каждую часть изТекущая или одна из базовых линий документа части. Закреплённая часть показывает 📌 и имя базовой линии в своей строке и экспортирует содержимое этой базовой линии.

Инструменты ИИ

✦ ИИ ▾ на верхней панели перечисляет инструменты ИИ для выбранного и для документа. Каждый результат ИИ сначала показывается для предпросмотра, и одно нажатие “Отменить” возвращает всё назад. В базовой линии инструменты отключены. См. ИИ.

  • Для выбранного Requirement или Statement: Переформулировать понятнее…, Добавить измеримые критерии… (требования), Упростить…, Разделить составное требование…, Составить обоснование…, Предложить имя…, Проверить с ИИ (это требование)…, Сгенерировать дочерние требования… и Сгенерировать тестовый случай… (требования).
  • Для любого выбранного элемента: Сгенерировать риски….
  • Для документа: Сгенерировать требования…, Составить сводку документа…, Перевести документ… и Проверить с ИИ (N требований)….

Сочетания клавиш

КлавишиДействие
⌘F / Ctrl+FПоиск в документе
Enter / Shift+EnterСледующее / предыдущее совпадение (в поле поиска)
⌘↵ / Ctrl↵Добавить элемент после выбранного
⌥⌘↵ / Ctrl+Alt↵Добавить дочерний элемент выбранного
⌥⇧→ / Alt+Shift+→ / ⌥⇧← / Alt+Shift+←Увеличить / уменьшить отступ выбранного элемента
⌥ / Alt+↑ / ⌥ / Alt+↓Переместить выбранный элемент вверх / вниз
↑ / ↓Выбрать предыдущую / следующую строку; фокус перемещается вместе с ней
TabСледующее поле: выбранная строка, затем её номер, имя и описание
Enter / F2На строке — изменить её имя; на номере, имени или описании — изменить его
Delete или BackspaceУбрать выбранные элементы из документа (отмена в сообщении)
⇧Delete / Shift+DeleteУдалить выбранные элементы и их дочерние элементы после подтверждения
EscСнять выбор; в поле поиска — очистить поиск
Enter / EscСохранить / отменить изменение номера или имени (фокус остаётся в поле)
↑ ↓ Home End в структуреПеремещение по элементам структуры
→ / ← в структуреРазвернуть / свернуть элемент или перейти к его первому дочернему элементу / к родителю
Enter / Space в структуреОткрыть элемент в документе (фокус переходит на его строку) / выбрать его
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZОтменить / повторить (вне редактора)

В Windows и Linux используйте Ctrl вместо ⌘ / Ctrl и Alt вместо ⌥ / Alt. Сочетания для строк работают, когда ни одно поле не в фокусе. ⌘↵ / Ctrl↵ и ⌥⌘↵ / Ctrl+Alt↵ работают и при изменении номера или имени. См. Сочетания клавиш и клавиши редактора форматированного текста выше.

Настройки, запоминаемые в этом браузере

Хранится в этом браузере:

  • Скрыта ли панель структуры и её ширина.
  • Столбцы и ширина столбцов для каждого документа.
  • Сортировка списка.
  • Текущий класс для новых элементов.
  • Последний тип отчёта.
  • Шаблоны, сохранённые до версии 1.8.0, пока вы не импортируете их в проект.

Сохраняется вместе с документом и доступно всем участникам проекта: Paper, Trace Status, шаблон Word, нумерация документа, шаблон нумерации и первый номер, а также автоматическая перенумерация. Шаблоны Word проекта сохраняются вместе с проектом.

Сообщения

СообщениеЗначение и исправление
Нет документов / “Создайте документ через + Новый документ или импортируйте Word, Excel, CSV или ReqIF через “Импорт”.”В проекте ещё нет документов.
“Нет подходящих документов. Очистите поиск или выберите “Все”.”Очистите Поиск документов… или нажмите Все.
Документ не найденАдрес указывает на удалённый документ. Используйте К документам.
Этот документ пуст / “Добавьте требование через “+ Новое требование” или заполните документ из шаблона через Писать → Применить шаблон….”Добавьте элементы или примените шаблон.
“Нет элементов, соответствующих фильтру. Сбросьте фильтр, чтобы увидеть все элементы.”Измените или сбросьте фишки классов и меток.
Отфильтрованный вид: редактирование отключено. Сбросить фильтр / “Сбросьте фильтр или сортировку, чтобы добавлять сущности”Создание содержимого приостановлено; щёлкните предупреждение, чтобы сбросить фильтр.
“Сначала введите текст.”Быстрое добавление отправлено пустым.
“Выбранную сущность нельзя переместить дальше в этом направлении.”Элемент первый или последний, заблокирован или находится рядом с заблокированным элементом.
“Сущность нельзя поместить под её собственный дочерний элемент. Выберите другого родителя.”Выберите цель вне поддерева элемента.
Устарело (столбец Quality Score)Текст изменился после последней проверки качества. Запустите её снова.
“Не удалось загрузить шаблоны документов.”Каталог шаблонов не загрузился; перезагрузите страницу.
“Предпросмотр доступен только для экспорта электронных таблиц. Выберите экспорт в Excel.”Предпросмотр работает только для отчётов Excel.
“У этого документа нет базовой линии. Сначала сохраните её.”Создайте базовую линию, прежде чем запускать отчёты об изменениях.
“Экспорт не выполнен: … Проверьте шаблон Word, затем повторите экспорт.”Экспорт в Word одним щелчком не выполнен; проверьте шаблон в Редактировать шаблоны Word….
“Изображение превышает лимит N МБ.” / “Файл превышает лимит N МБ.”Файл больше предельного размера файла на сервере.

Ограничения

Ограничение: имена, изменяемые в строке документа, ограничены 200 символами, номера — 139. Быстрое добавление принимает 2000 символов.

Ограничение: изображения уменьшаются до 4000 пикселей по длинной стороне. Вложенные файлы и изображения ограничены предельным размером файла на сервере (10 МБ на тарифе Free, 25 МБ на Individual, 100 МБ на Team) и квотой хранилища проекта.

Ограничение: вывод в Word встраивает только изображения PNG, JPEG и GIF. Уровни заголовков глубже 6 отображаются как Heading 6.

Ограничение: шаблоны организации существуют на серверах Holarch (облачных или собственных), а не в настольном приложении; настольное приложение хранит шаблоны проекта в файле проекта. Организация хранит до 200 шаблонов, в каждом до 3000 разделов. Шаблоны, сохранённые в одном проекте, не предлагаются в других проектах: сохраните шаблон в организацию или сохраните его ещё раз в другом проекте.