Вимоги
Документи
Пишіть, структуруйте, нумеруйте, фіксуйте в базовій лінії та публікуйте специфікації як живі подання моделі, з шаблонами, форматованим текстом, звітами та виведенням у Word.
На цій сторінці
- Огляд
- Поняття
- Як користуватися
- Список документів
- Сторінка документа
- Додавання елементів
- Реструктуризувати
- Нумерація
- Шаблони
- Редактор форматованого тексту
- Пошук у документі
- Знайти й замінити
- Меню “Написати”
- Меню “Перевірити”
- Меню “Видати”
- Меню “Вигляд”
- Базові лінії
- Звіти
- Вихідний файл Word
- Коментарі
- Збірки
- Інструменти ШІ
- Комбінації клавіш
- Налаштування, що запам’ятовуються в цьому браузері
- Повідомлення
- Обмеження
- Пов’язане
Огляд
Документ — це специфікація, план чи процедура, розділи й вимоги якої є сутностями моделі. Використовуйте сторінку документа, щоб писати й реструктуризувати їх, нумерувати, фіксувати в базових лініях і публікувати у Word, Excel, ReqIF, Markdown та інших форматах.
Кожен елемент документа — сутність. Тож та сама вимога також з’являється в Базі даних, на діаграмах, у Матриці простежуваності й у перевірці якості. Редагування в будь-якому з цих місць видно в документі.
Поняття
Що робить щось документом
- Документ — це сутність Artifact, яка відповідає одній із двох умов:
- Вона має мітку типу документа: будь-яку мітку, назва якої закінчується на “Document”.
- Вона є source of щонайменше для одного Statement чи Heading.
- Її елементи верхнього рівня — сутності, для яких документ є source of. Глибші елементи підвішено під ними через зв’язки decomposed by. Структура, яку ви бачите, — це дерево декомпозиції.
- Елементи зазвичай є Statements (розділи, заголовки, примітки, припущення) і Requirements (та їхні підкласи). Додайте будь-який інший клас через Інший клас….
- Headings (структуровані документи LML 2.0) — розділи, що містять елементи будь-якого класу. Підрозділ — це Heading під Heading (decomposed by). Будь-який інший елемент під Heading — вміст розділу: Heading його contains, він зберігає власний номер і перелічується перед підрозділами. Див. Структуровані документи із заголовками.
- Вилучення елемента з документа не видаляє сутність. Видалення з Бази даних — видаляє.
Типи документів
Тип — це мітка типу документа. Вона визначає, які шаблони пропонуються першими і чи відкривається документ у паперовому режимі.
| Тип | Вбудовані шаблони |
|---|---|
| Requirements Document | Специфікація вимог; специфікація вимог зацікавлених сторін (StRS); специфікація системних вимог (SyRS); специфікація вимог до програмного забезпечення (SRS); специфікація вимог до інтерфейсів (IRS) |
| Interface Control Document | Документ контролю інтерфейсів (ICD) |
| Concept of Operations Document | Концепція експлуатації |
| Needs Analysis Document | Аналіз потреб |
| Concept Exploration Document | Дослідження концепції; звіт про аналіз компромісів |
| Concept Definition Document | Визначення концепції; опис архітектури |
| Systems Engineering Management Plan Document | План управління системною інженерією |
| Test Plan Document | План тестування; план верифікації та валідації; процедура тестування; звіт про тестування |
| Independent Verification & Validation Plan Document | План незалежної верифікації та валідації (IV&V) |
| Project Management Plan Document | План управління проєктом; план управління ризиками; план управління конфігурацією |
| Integrated Logistics Support Plan Document | План інтегрованої логістичної підтримки |
| Standard Operating Procedure Document | Стандартна операційна процедура |
Шаблони інших типів перелічено в Інші шаблони, тож будь-який шаблон може започаткувати будь-який документ.
Щоб додати тип документа, додайте до класу Artifact мітку, назва якої закінчується на “Document” (див. Розширення схеми). Документ із міткою Пакет рецензування збирає інші документи; див. Збірки.
Числа
Кожен елемент має номер, як-от 3.2, показаний перед його назвою. Номери зберігаються на сутності, тож та сама вимога всюди показує той самий номер. Виняток — нумерація документа, що зберігає окремі номери для кожного документа.
Holarch підтримує порядок номерів за вас, поки ввімкнено Автоматично перенумеровувати після додавання або переміщення елементів (типово; прапорець є в Написати ▾ → Перенумерувати…).
Базові лінії
Базова лінія — знімок документа лише для читання. Вона містить:
- Елементи документа, їхні атрибути й зв’язки, включно зі зв’язками із сутностями на один крок поза документом.
- Налаштування документа.
- Датовані записи про затвердження, які згодом не можна редагувати.
Базові лінії живлять звіти про зміни й таблиці Revision History і Approvals вихідного файлу Word.
У хмарному сервісі:
- Кожен запис про затвердження отримує час сервера й обліковий запис, що його зберіг, а не годинник браузера. Запис показує “(час сервера) · записав {name}”, а збереження записується до журналу аудиту.
- Лише власники проєкту можуть перейменовувати чи видаляти базову лінію. Для інших Видалити і поле назви неактивні з повідомленням “Лише власник проєкту може перейменувати чи видалити базову лінію.” Відновлення й повернення працюють як раніше.
У настільному застосунку записи мають дату, коли їх зберіг ваш комп’ютер.
Як користуватися
Коли й навіщо
Використовуйте документ, коли результатом є специфікація, яку хтось прочитає, перегляне й підпише. Приклади:
- Специфікація системних вимог для SRR.
- Концепція експлуатації на ранньому етапі розроблення концепції.
- План тестування до початку верифікації.
- Процедура для експлуатації.
Пишіть вимоги тут, потім простежуйте їх до функцій, активів і тестів в інших частинах моделі. Документ відповідає на запитання “Що каже ця специфікація, в якому порядку і що змінилося після її затвердження?”
У процесі системної інженерії документи йдуть першими: потреби зацікавлених сторін і системні вимоги. Вони живлять функціональний аналіз і розподіл. На рецензуваннях вони повертаються як затверджені результати в базових лініях зі звітами про простежуваність.
Створити специфікацію вимог із шаблону
- На панелі навігації відкрийте Потреби та вимоги → Документи.
- Натисніть + Новий документ у заголовку сторінки.
Відкривається Новий документ.
- Введіть Назву (обов’язково). Номер і опис можна додати пізніше в інспекторі.
- У розділі Шаблон поле Шаблони для показує шаблони одного типу документа, наприклад Requirements Document. Кожна картка показує перші розділи як попередній перегляд. Виберіть одне з:
- Порожній: порожній документ показаного типу.
- Запис Шаблони організації (сервери Holarch, хмарні чи власні), опублікований адміністраторами вашої організації. Типовий шаблон організації для цього типу вибрано заздалегідь.
- Запис Шаблони проєкту, збережений у цьому проєкті.
- Запис Вбудовані шаблони.
- Шаблон іншого типу документа в розділі Інші шаблони.
Документ отримує тип вибраного шаблону.
- Виберіть Включити настанови з написання, щоб додати коротку настанову до кожного розділу вбудованого шаблону.
- Натисніть Створити.
Документ відкривається з нумерованими розділами шаблону, наприклад 1 Document Control, 1.1 Revision History, 1.2 Approvals, 2 Introduction … Якщо ви включили настанови, видаляйте їх, коли пишете кожен розділ.
Писати вимоги
- Натисніть рядок розділу, щоб вибрати його.
- Натисніть + Дочірній або натисніть ⌥⌘↵ / Ctrl+Alt↵.
З’являється новий рядок “New Requirement” з номером, і його назва готова до введення.
- Введіть назву й натисніть Enter.
- Натисніть опис і напишіть твердження з “shall”.
- Натисніть ⌘↵ / Ctrl↵ або клацніть деінде, щоб зберегти опис.
- Щоб додати наступну вимогу на тому самому рівні, знову натисніть ⌘↵ / Ctrl↵.
+ Створити … (заголовок сторінки) додає елемент у кінець документа; + Після і + Дочірній додають його біля вибраного елемента (про це каже підказка + Створити …). Усі три додають останній клас, вибраний з їхніх меню ▾ (типово Requirement). Цей браузер запам’ятовує вибір.
Швидко додати багато вимог
Використовуйте Швидке додавання внизу документа, щоб вводити вимоги одну за одною.
- На панелі Швидке додавання виберіть розділ, наприклад Під 4 Command and Data Handling.
- Введіть текст вимоги.
- Натисніть Enter.
Holarch додає вимогу й називає її за словами після “shall”. Курсор залишається в полі для наступної.
Реструктуризувати
Змінюйте структуру клавішами, перетягуванням або з контекстного меню. Коли автоматичну перенумерацію ввімкнено, номери оновлюються після кожного переміщення.
- Клавішами: виберіть рядок, потім натисніть:
- ⌥⇧→ / Alt+Shift+→, щоб збільшити відступ і вкласти його під елемент вище.
- ⌥⇧← / Alt+Shift+←, щоб зменшити відступ.
- ⌥ / Alt+↑ або ⌥ / Alt+↓, щоб перемістити його серед сусідніх.
- Tab не використовується для відступів, тож він завжди переходить до наступного поля.
- Перетягуванням: перетягуйте рядки на панелі Структура. Відпустіть на верхньому чи нижньому краї рядка, щоб розмістити елемент перед ним чи після нього. Відпустіть посередині, щоб зробити його дочірнім.
- З меню: клацніть рядок правою кнопкою, виберіть Перемістити під ▸, потім виберіть новий батьківський елемент зі списку (введіть текст, щоб відфільтрувати). Дочірні елементи переміщуються разом.
Рецензувати, зафіксувати в базовій лінії й опублікувати
- Виберіть Перевірити ▾ → Перевірити якість і виправте слабкі вимоги (див. Вимоги).
- Виберіть Перевірити ▾ → Статус простежуваності… і зв’яжіть вимоги, які ще не розподілено чи не верифіковано.
- Закрийте відкриті елементи в Перевірити ▾ → Реєстр TBD/TBR.
- Перегляньте Перевірити ▾ → Зв’язки для перевірки.
- В основному написі натисніть Версія ▾ і виберіть Зберегти базову лінію….
- Введіть назву, наприклад “SRR Baseline”.
- Додайте по рядку затвердження на кожного затверджувача з іменем, роллю й заявою.
- Натисніть Створити.
Базова лінія з’являється у Версія ▾, а кнопка називає її останньою базовою лінією.
- Натисніть Видати ▾ → Специфікація (Word).
Файл Word завантажується з параметрами шаблону Specification, включно з таблицями Revision History і Approvals, заповненими з базових ліній.
- Відкрийте файл у Word і прийміть запит на оновлення полів.
Зміст заповнюється.
Щоб документ рецензували до базової лінії, натисніть Запитати рецензування біля типу документа. Рецензенти проєкту знаходять його в розділі Документи для рецензування на сторінці Моя робота і затверджують чи відхиляють його там або на смузі під заголовком.
Після пізніших змін подивіться, що змінилося:
- Натисніть Версія ▾ → Порівняти версії….
- Виберіть базову лінію в Від і Поточна версія в До.
Звіт перелічує кожне додавання, вилучення й редагування. Натисніть Зміни (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 мають низькі оцінки.
Виправте слабке формулювання:
- Натисніть ⌘F / Ctrl+F і введіть
should.Лічильник показує збіги.
- Натискайте Enter, доки не буде позначено 2.5.
Її текст — “The spacecraft should recover from safe mode quickly and resume imaging as appropriate”.
- Перепишіть її, наприклад “The spacecraft shall resume imaging within 24 hours of a safe mode entry.”
Стовпець оцінки показує тег Застаріло, доки ви знову не запустите перевірку.
Поділіть складену вимогу:
- Виберіть 6.4 Operator Interface (“…shall be user friendly and/or easy to use.”).
- Клацніть її правою кнопкою й виберіть Поділити на кілька елементів….
- Натисніть ✦ Запропонувати поділ.
Ви отримуєте по одній вимірюваній вимозі на рядок.
- Зніміть позначку з непотрібних рядків або натисніть Об’єднати, щоб злити рядок із наступним, і натисніть Застосувати.
Швидко додайте вимогу:
- У Швидке додавання виберіть Під 3 Electrical Power.
- Введіть “The EPS shall provide a 5 V regulated bus within 3%.” і натисніть Enter.
Її додано як 3.7 з назвою “Provide A 5 V Regulated”.
Подивіться, що змінилося після SRR:
- Натисніть Версія ▾ в основному написі й виберіть SRR Baseline.
Банер показує “Базова лінія “SRR Baseline”, лише для читання, збережено {date}”. Затверджувачі: J. Rivera, Systems Lead; R. Okafor, Mission Principal Investigator; і L. Brandt, Program Manager.
- Натисніть Порівняти з поточною.
Звіт перелічує:
- 3.1 Orbit Average Power: опис змінено з 28 W на 30 W, і нове обґрунтування.
- 2.4 Target Slew: Status Draft → In Review.
- Додану 4.4 Downlink Encryption з її двома новими зв’язками satisfies.
- Ваші власні зміни з цього сеансу.
Опублікуйте:
- Натисніть Повернутися до поточної.
- Натисніть Видати ▾ → Специфікація (Word).
Файл Word починається з назви й “Requirements Document · No. SRS-001”. Далі йдуть рядок Revision History для SRR Baseline (“Initial baseline”) і три затвердження, потім нумеровані вимоги.
Поради та добрі практики
- Пишіть одну вимогу на рядок з одним “shall”. Поділити на кілька елементів… і перевірка якості допомагають зберігати вимоги одиничними.
- Залишайте розділи як Statements, а вимоги як Requirements. Перевірка якості оцінює лише Requirements. Звіти лише для вимог (RVTM, VCRM, RTM) пропускають Statements.
- Створюйте базову лінію перед кожним рецензуванням і перед великими переписуваннями. Від неї залежать повернення та звіти про зміни.
- Клацання рядка вибирає його. Щоб редагувати, натисніть саме поле або натисніть Enter чи F2 на вибраному рядку.
- Використовуйте Вигляд ▾ → Папір, щоб читати документ як сторінку, без стовпців атрибутів. Вимкніть його, щоб редагувати атрибути в стовпцях.
- Стежте за точками статусу простежуваності: вимога готова до рецензування, коли її точка зелена.
Типові помилки
- Додавання неактивне. Активний фільтр чи сортування (Відфільтроване подання: редагування вимкнено. Очистити фільтр на панелі інструментів), або ви переглядаєте базову лінію. Натисніть попередження або Повернутися до поточної.
- Номери змінилися після переміщення. Автоматична перенумерація переписує номери групи сусідніх елементів. Щоб зберегти задані вручну номери, зніміть позначку Автоматично перенумеровувати після додавання або переміщення елементів у Написати ▾ → Перенумерувати… або заблокуйте елементи, номери яких не повинні змінюватися.
- Елемент вилучено, але він досі в Базі даних. Вилучити лише прибирає його з документа. Щоб видалити його, виберіть Видалити елемент… у повідомленні, що з’являється далі, клацніть Вилучити з ⇧ / Shift або натисніть ⇧Delete / Shift+Delete.
- Літерна чи римська нумерація стала десятковою. Автоматична перенумерація й Перенумерувати… створюють десяткові номери (1, 1.1, 1.1.1). Щоб зберегти додатки з літерами, вимкніть автоматичну перенумерацію й нумеруйте їх вручну.
Як це пов’язано з іншими функціями
- Отримує дані з:
- Імпорт створює документи з Word, Excel, CSV, ReqIF, XMI і тексту.
- Шаблони створюють каркас.
- Генератори ШІ додають вимоги.
- Передає дані до:
- Вимоги простежуються до функцій, активів і тестових випадків (Простежуваність).
- Перевірка якості, реєстр TBD/TBR, зв’язки для перевірки й затвердження працюють із вимогами документа.
- Вигляд ▾ → Відкрити в ▸ Функціональний аналіз виводить функції з документа.
- Звіти створюють RVTM, VCRM і звіти про зміни.
- Рецензування збирають документи у збірки.
- Скрізь інде: кожен елемент — сутність. Він з’являється в Базі даних, Поданні елемента й на діаграмах, як-от 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 або клавішу Menu; меню відкривається біля елемента, а Esc повертає фокус туди. На сенсорному екрані торкніться елемента й утримуйте. Елемент стає виділенням.
Меню починається з не більше ніж трьох запропонованих дій, вибраних за станом елемента, кожна з причиною праворуч: наприклад, ✦ Add Measurable Criteria… (не проходить: 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 ▸, Пріоритет ▸, Зв’язати з ▸, переміщення й Видалити елемент… неактивні.
- Поки активний фільтр чи сортування, додавання й переміщення неактивні (“Спершу очистьте фільтр або сортування”).
- Команди, що перемістили б елемент за початок чи кінець його рівня, неактивні (наприклад, Перемістити вгору на першому елементі).
Вибрано кілька елементів. Клацання правою кнопкою на елементі виділення діє на всі вибрані елементи. Меню показує Вибрано: N і пропонує пакетні дії ✦ (✦ Перевірити за допомогою ШІ (n вимог)…, ✦ Переписати (n) ▸, ✦ Згенерувати тестові випадки (n)…, ✦ Запитати ШІ про ці (n)…, ✦ Запропонувати трасування (n)…; див. ШІ для кількох вибраних елементів), Задати Status ▸, Задати пріоритет ▸, Додати до документа ▸, Вилучити n з цього документа і Видалити n елементів… (після підтвердження; дочірні елементи вибраних видаляються разом із ними). Команди для одного елемента (Перейти, Відкрити, Перейменувати…, додавання, відступи й переміщення) залишаються в списку, але неактивні з причиною “Діє на одну сутність”. Кожна команда — один крок відміни. Клацання правою кнопкою на елементі поза виділенням робить його єдиним вибраним.
Опис і будь-яке поле, яке ви редагуєте, зберігають власне меню браузера, тож там можна копіювати, вставляти й перевіряти правопис. ⌥ / Alt-клацання правою кнопкою показує меню браузера будь-де.
Швидке додавання
Швидке додавання дає змогу вводити вимоги поспіль без панелі інструментів. Панель під документом містить Швидке додавання, список розділів, текстове поле й Додати. Список розділів пропонує Кінець документа і Під {number name} для кожного розділу верхнього рівня.
Введіть вимогу й натисніть Enter або Додати. Новий елемент отримує:
- Поточний клас.
- Текст як свій опис.
- Назву з перших слів після “shall”, “must”, “will” або “should”: до п’яти слів, кожне з великої літери.
Поле приймає до 2,000 символів. Поки ввімкнено фільтр чи сортування, поле показує “Очистьте фільтр або сортування, щоб додавати сутності”.
Інспектор
Вибраний елемент відкривається в інспекторі праворуч з повною панеллю сутності (див. Модель і база даних).
- У документі зв’язки decomposed by і decomposes там доступні лише для читання, бо ними керує структура.
- × заголовка (Esc) очищає вибір. Вигляд ▾ → Згорнути дочірні згортає розділи під вибраним елементом.
- Заблоковані елементи відкриваються лише для читання.
Додавання елементів
Нові елементи
- + Створити {Class} додає в кінець.
- + Після додає після вибраного елемента.
- + Дочірній додає останній дочірній вибраного елемента, і батьківський розгортається.
- Без вибору + Після і + Дочірній додають у кінець.
Новий елемент отримує назву “New {Class}”. Його вибрано, а назва відкрита для редагування.
Інші класи
Інший клас… відкриває Додати елемент до документа з Клас (будь-який клас) і Назва. Використовуйте його для елементів, що не є Statement, як-от опису Asset чи Test Case у плані тестування.
Структуровані документи із заголовками
Heading — розділ документа (підхід структурованих артефактів LML 2.0). Використовуйте Headings, коли розділ поєднує класи, наприклад вимоги, дії й ризики, або коли та сама вимога з’являється в кількох документах.
- Виберіть Заголовок у меню класів (+ Створити ▾, + Після ▾ або + Дочірній ▾). Для Heading на верхньому рівні документ є його source of; під іншим Heading це нумерований підрозділ.
- Виберіть Heading і скористайтеся + Дочірній ▾, щоб додати його вміст: новий елемент будь-якого класу або Додати наявний елемент…. Heading contains елемент.
- Вміст зберігає власний номер: додавання, переміщення й Перенумерувати… нумерують Headings і не змінюють номерів вмісту, тож вимога на кшталт RQ.CLN.1 має однаковий вигляд у кожному документі. Вміст розділу перелічується перед підрозділами.
Переміщення вмісту до іншого Heading (перетягуванням, Перемістити під ▸) переносить його зв’язок contains. Перевірки моделі вважають вимогу, яку містить Heading, розміщеною в документі.
Щоб записати, звідки походить вимога, зв’яжіть її з Artifact-джерелом через originated by (інспектор → Зв’язки; Artifact перелічує її в originates). Проєкт, створений до появи Headings, зберігає свою схему; Схема → Додати нові вбудовані… додає 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 розділів” для 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 |
| Statements з міткою Acronym | Кожен розділ Acronyms |
| Artifacts з міткою Reference | Кожен розділ References |
| Risks; Artifacts Trade Study | Risk Management Plan; Trade Study Report |
Матриця, що охоплює “цей документ”, вказує на новий документ. Для Test Report додайте результати циклу тестування через Вставити ▸ Матриця… ▸ Test Report і виберіть набір тестів і цикл.
Зберегти документ як шаблон
Збережіть структуру документа як шаблон, щоб починати з неї нові документи.
- Виберіть Написати ▾ → Шаблони ▸ Зберегти як шаблон….
Відкривається Зберегти {Type} як шаблон.
- Введіть Назву шаблону.
- У Зберегти в виберіть:
- Цей проєкт: кожен учасник проєкту може ним користуватися. Цей варіант бачать лише власники проєкту.
- Організація: {name} (сервери Holarch, адміністратори організації): кожен учасник організації може ним користуватися. Позначте Зробити типовим для організації для {Type}, щоб він був вибраний заздалегідь у “Новий документ”.
- Позначте Включити файли й зображення, якщо шаблон має їх зберегти.
- Натисніть Зберегти.
Шаблон зберігає клас, назву, номер, опис, рівень, мітки й прості значення атрибутів кожного елемента. Результати якості не зберігаються. Матриця, що охоплює збережений документ, охоплює новий документ, коли шаблон застосовано.
Якщо ви не можете зберегти жоден вид, діалог про це повідомляє: зверніться до власника проєкту або адміністратора організації.
Керувати шаблонами
Написати ▾ → Шаблони ▸ Керувати шаблонами… перелічує шаблони проєкту. Власники можуть Перейменувати і Вилучити їх; відміна відновлює вилучений шаблон. Документи, створені із шаблону, не змінюються.
Адміністратори організації керують шаблонами організації в Налаштування організації → Шаблони документів: відкрийте організацію й скористайтеся Шаблони документів, щоб перейменувати шаблон, увімкнути чи вимкнути Типовий (один типовий на тип документа) або вилучити його.
Шаблони, збережені в цьому браузері
До версії 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) вставляє зображення.
- Зображення, довша сторона яких перевищує 4,000 px, зменшуються. Повідомлення показує “Зображення зменшено до W × H px (обмеження — 4000 px за довшою стороною).”
- Файл зображення понад обмеження для одного файлу перемальовується шириною 1,600 px як JPEG. Якщо він однаково завеликий, сповіщення показує “Зображення перевищує обмеження N МБ.”
- Файл… вкладає будь-який файл як посилання для завантаження зі значком його типу. Файли понад обмеження показують “Файл перевищує обмеження N МБ.”
Альтернативний текст
Альтернативний текст описує зображення для програм зчитування з екрана та в перевірці доступності Word.
- + → Альтернативний текст… перелічує кожне зображення в тексті з його альтернативним текстом і полем Декоративне. Він попереджає, коли зображення не має альтернативного тексту або коли альтернативний текст — ім’я файлу.
- Двічі клацніть зображення або клацніть його правою кнопкою й виберіть Редагувати альтернативний текст…, щоб редагувати лише його.
- Зображення діаграм (Діаграма…) беруть альтернативний текст із підпису: тип діаграми й назва сутності.
- Вихідний файл Word записує альтернативний текст в опис кожного зображення. Декоративне зображення позначається як декоративне.
Посилання й вбудовані посилання
- Посилання… (Вставити посилання) приймає URL і Текст. Адреси без
http:,https:,mailto:або#отримуютьhttps://. Посилання відкриваються в новій вкладці. - Посилання на документ… (Вставити посилання на документ) посилається на інший документ. Воно приймає Документ, Версія (Поточна або Базова лінія: {name}) і Текст.
- У вихідному файлі Word документи, пов’язані так, можна додати як додатки.
- Якщо інших документів немає, сповіщення показує “У цьому проєкті немає інших документів. Спершу створіть документ.”
Живий вміст
Живий вміст залишається актуальним відносно моделі всюди, де показано текст: у документі, в інспекторі, в експорті й у пошуку.
- Діаграма… (Вставити діаграму): виберіть Тип діаграми і сутність (або дошку чи рамку). Вставляє зображення діаграми з підписом, що посилається на діаграму.
- Зображення живе. Коли модель змінюється, документ невдовзі показує нове зображення, а Word та інші формати експорту малюють його заново.
- Щоб зберегти поточне зображення, двічі клацніть рисунок у редакторі (Рисунок діаграми) і вимкніть Оновлювати зображення, коли змінюється модель. Тоді рисунок стає знімком.
- Оновити рисунки діаграм (у +) одразу перемальовує кожен живий рисунок у тексті.
- Коли сутність діаграми видалено, рисунок зберігає останнє зображення.
- Живе значення…: виберіть сутність і Атрибут. Редактор показує її “Живе значення”. Щоб змінити атрибут, двічі клацніть живе значення (Редагувати живе значення).
- Кількість або сума… вставляє число, що перераховується з моделі, для резюме чи рядка стану на кшталт “12 з 40 вимог верифіковано” (дві кількості). Його поля:
- Запит: які сутності рахувати, наприклад
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}.
- Виберіть Розрізати за реченнями або Розрізати за абзацами, а також Нові елементи як його дочірні або Нові елементи після нього.
Таблиця показує по одному запропонованому елементу на частину з номером, редагованими Назва і Текст.
- Або натисніть ✦ Запропонувати поділ, щоб ШІ запропонував одиничні вимоги (до 20).
- Рядки, текст яких містить вебадресу, спочатку не позначені.
- Коли оригінал затверджено, зафіксовано в базовій лінії чи заблоковано, заміна його тексту — непозначений варіант, який треба вибрати явно.
- Порівняння показує рядок 1 відносно оригіналу.
- Редагуйте назви й текст. Об’єднати зливає частину з наступною.
- Зніміть позначку з непотрібних частин і натисніть Застосувати.
Частина 1 (“залишається”) залишається в оригінальному елементі. Кожна позначена частина стає новим елементом того самого класу з тими самими мітками. Номери пропонуються автоматично; з увімкненою автоматичною перенумерацією їх перепризначають після поділу. Одне натискання “Відмінити” повертає назад увесь поділ; сповіщення показує “Поділено на елементів: N”.
Меню “Перевірити”
Перевірити ▾ перелічує, що потребує уваги в цьому документі, з кількостями праворуч:
| Елемент обміну | Що він робить |
|---|---|
| Перевірити якість | Перевіряє кожну вимогу документа, що проходить поточний фільтр, і відкриває результати. Коли вибрано вимогу, пункт — Перевірити якість цієї вимоги. Якщо вимог немає: “Цей документ не має Requirements для перевірки. Statements не оцінюються.” |
| Перевірки моделі для цього документа… | Відкриває Перевірки моделі для цього документа: зауваження Перевірок моделі для документа та його елементів (правило, елемент, зауваження) і живий вміст, що вказує на щось відсутнє. Натисніть елемент, щоб вибрати його. Якщо зауважень немає: “Немає зауважень для цього документа.” Відкрити перевірки моделі відкриває сторінку для всього проєкту. |
| Статус простежуваності… | Показує “Завершено N з M” і відкриває Статус простежуваності: вимоги, які ще не розподілено чи не верифіковано, кожна з точкою і тим, чого бракує (satisfied by, verified by). Натисніть одну, щоб вибрати її. Відкрити RVTM відкриває сторінку RVTM. Показується, коли документ має вимоги. |
| Зв’язки для перевірки | Відкриває Зв’язки для перевірки для цього документа. |
| Реєстр TBD/TBR | Відкриває реєстр TBD/TBR для цього документа. |
| Знайти акроніми… | Див. Пошук акронімів. |
| Коментарі | Показує кількість відкритих коментарів і відкриває їх в інспекторі (див. Коментарі). |
Статус простежуваності
Точка після значків кожної вимоги показує її статус простежуваності:
- Зелений: вимога satisfied by чимось (розподілена) і verified by чимось.
- Бурштиновий: одного з двох бракує.
- Червоний: жодного зв’язку немає.
Наведіть вказівник на точку, щоб побачити статус і те, чого бракує, наприклад “Статус простежуваності: частково простежено. Бракує: немає зв’язку verified by (не верифіковано).” Натисніть її, щоб відкрити меню з елементами в Satisfied by (розподіл) і Verified by (натисніть один, щоб відкрити), Відкрити в RVTM і Зв’язати з ▸. Statements та інші класи не мають точки. У базовій лінії точки показують зв’язки базової лінії. Вимкніть точки через Вигляд ▾ → Статус простежуваності.
Пошук акронімів
Перевірити ▾ → Знайти акроніми… знаходить акроніми в номерах, назвах і описах документа та додає їх до його розділу глосарію одним списком для перегляду.
- Акронім — це дві або більше великих літер, до восьми символів, не всі цифри.
- Розшифровка береться з наявного запису проєкту або зі слів поруч із терміном, перші літери яких його утворюють (“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, а не вміст (вміст заповнюють шаблони документів; див. Шаблони). Кожен документ використовує один; типовий — Специфікація. Виберіть його в Видати ▾ → Шаблон Word ▸.
Вбудовані шаблони:
| Заготовка | Параметри |
|---|---|
| Специфікація | Зміст до рівня 3, нумеровані підписи, переліки рисунків і таблиць, історія редакцій і затвердження з базових ліній, зв’язані документи як додатки. Стовпці атрибутів, коли документ їх показує. |
| Результат за розділами | Як Специфікація, з підписами, нумерованими за розділами (Рисунок 3-1), і заголовками всередині описів у змісті. |
| Копія для рецензування | Альбомні сторінки зі стовпцями атрибутів документа під кожним елементом; зміст до рівня 2, без таблиць вступної частини. |
| Простий | Назва, заголовки й текст: без змісту, номерів підписів і таблиць вступної частини. |
Усі вбудовані шаблони використовують сторінки Letter.
Редагувати шаблони Word… відкриває Шаблони Word. Вбудовані шаблони мають Копіювати; копія стає шаблоном проєкту, що зберігається в проєкті для кожного учасника. Виберіть шаблон проєкту, щоб змінити:
- Назва, Розмір сторінки (Letter (8.5 × 11 in) або A4 (210 × 297 mm)) і Орієнтація (Книжкова або Альбомна).
- Зміст (Немає, Рівень 1, Рівні 1–2, Рівні 1–3, Рівні 1–4, Усі рівні) і Нумерація підписів (Рисунок 1, Таблиця 1, За розділами: Рисунок 3-1 або Вимкнено).
- Перелік рисунків і перелік таблиць (якщо є підписи), Заголовки всередині описів з’являються в змісті, Стовпці атрибутів, показані в документі, під кожним елементом, Зв’язані документи як додатки і Історія редакцій і затвердження з базових ліній.
- Видалити шаблон.
Натисніть Зберегти (одне натискання “Відмінити” повертає зміну назад; сповіщення показує “Шаблони Word збережено.”). Документ, шаблон якого видалено, повертається до Специфікації.
Файли Word компанії
Шаблон проєкту може містити власний файл Word вашої організації (.docx або .dotx, до 5 МБ). Тоді експорт використовує з файлу:
- Стилі: шрифти, кольори, стилі заголовків і основного тексту. Стилі, яких бракує у файлі (підписи, записи змісту), додаються; нумерація заголовків із файлу відкидається, бо заголовки нумерує Holarch.
- Сторінку: розмір, орієнтацію й поля. Вибір файлу задає Розмір сторінки і Орієнтація шаблону відповідно до нього.
- Колонтитули з їхніми логотипами й номерами сторінок. До кожного додається гриф проєкту чи документа.
- Титульну сторінку: вміст файлу до першого розриву розділу або весь файл, якщо розриву немає. Вона замінює титульну сторінку Holarch.
На титульній сторінці й у колонтитулах заповнюються такі заповнювачі: {{Title}}, {{Type}}, {{Number}}, {{Version}}, {{Date}}, {{Project}}, {{Organization}}, {{Contract}}, {{CDRL}}, {{Prepared For}}, {{Prepared By}} і {{Baseline}}. Регістр і пробіли не мають значення. Інший текст у фігурних дужках залишається як написано.
Щоб додати файл:
- Виберіть Видати ▾ → Шаблон Word ▸ → Редагувати шаблони Word….
- Натисніть Вибрати… у рядку Файл Word компанії або виберіть шаблон проєкту й натисніть Вибрати… під Файл Word компанії.
- Виберіть файл. Натисніть Зберегти.
Замінити… замінює файл, а Вилучити повертає стилі й титульну сторінку 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 зберігаються з документом. Позиція горизонтального прокручування не змінюється, коли ви вибираєте рядок.
Базові лінії
Версія ▾ в основному написі перелічує Поточна версія, базові лінії цього документа і, у розділі Базові лінії проєкту, базові лінії проєкту (кожна зі своєю датою; ✔ позначає показану). Наприкінці є Зберегти базову лінію… і Порівняти версії…. Видати ▾ → Версія ▸ має ті самі дві команди.
Створити базову лінію
- Натисніть Версія ▾ → Зберегти базову лінію… (неактивна, поки показано базову лінію: “Спершу поверніться до поточної версії”).
Зберегти базову лінію відкривається з приміткою “Базова лінія зберігає цю версію документа (його елементи, їхні атрибути та зв’язки), щоб пізніше переглянути, порівняти й відновити її. Записи про затвердження датуються поточним моментом і згодом не редагуються.”
- Введіть Name (обов’язково). Типове значення — “{document} Baseline N”.
- У розділі Затвердження заповніть по одному рядку на кожного затверджувача: Name, Роль і Statement. Перший рядок заздалегідь заповнено вашим ім’ям. Типове твердження — “Approved for release.”
- Натисніть + Додати затверджувача, щоб додати рядки, або ×, щоб вилучити рядок. Рядки без імені ігноруються.
- Натисніть Створити.
Сповіщення показує “Базову лінію збережено”.
Переглянути базову лінію
Виберіть базову лінію у Версія ▾. Банер показує “Базова лінія “{name}”, лише читання, збережено {date}” (з “· базова лінія проєкту” для базової лінії проєкту) разом із затверджувачами. Він пропонує:
- Повернутися до поточної: повертає до робочої копії.
- Редагувати (базові лінії документа): відкриває Редагувати базову лінію. Перейменуйте базову лінію або додайте записи про затвердження в розділі Додати затвердження. “Нові записи датуються поточним моментом і додаються до списку. Наявні записи змінити не можна.”
- Порівняти з поточною (базові лінії документа): відкриває Порівняти версії від цієї базової лінії.
- Відновити базову лінію: запитує “Перезаписати сутності, порядок і структуру цього документа базовою лінією “{name}”? Сутності, додані відтоді, вилучаються з документа (не видаляються). Можна відмінити.”
- Для базової лінії проєкту відкривається Замінити проєкт базовою лінією: “Замінити весь проєкт базовою лінією проєкту “{name}”? Можна відмінити.”
- Видалити: запитує “Видалити базову лінію “{name}”?”
У базовій лінії редагування, швидке додавання та інструменти структури вимкнено, а структура показує 🔒. Видати ▾ створює вихідні файли з базової лінії (“Експорт (базова лінія “{name}”)”).
Живий вміст у базовій лінії показує модель базової лінії — на екрані й у вихідних файлах: живі значення, кількості й суми, живі таблиці, матриці та перехресні посилання обчислюються за знімком, а рисунки діаграм зберігають зображення, збережені з базовою лінією. Базова лінія документа містить документ, його елементи та сутності на відстані одного зв’язку, тож кількість або таблиця в ній охоплює ці сутності; живе значення сутності поза базовою лінією показує її поточне значення.
Порівняти версії
Версія ▾ → Порівняти версії… відкриває Порівняти версії. Порівнюється From (базова лінія) з To: пізнішою базовою лінією або Поточна версія. Без базових ліній показується “Цей документ не має базової лінії. Спершу збережіть її.”
Перелічується “N змін” зі стовпцями Номер, Назва, Тип зміни, Поле і Зміна. Для зміненого тексту Зміна показує порівняння слів.
Типи змін:
- Додано і Вилучено.
- Змінено: поле — Name, Number, Description, Class, Image або будь-який атрибут.
- Мітку додано і Мітку вилучено.
- Зв’язок додано, Зв’язок вилучено і Атрибут зв’язку.
Зміни (Excel) завантажує порівняння зі стовпцями Number, Name, Class, тип зміни, поле, старе значення й нове значення. Правки (Word) завантажує те саме порівняння як документ Word із правками (див. Правки).
Звіти
Видати ▾ експортує документ у Word, PDF, електронні таблиці та інші формати. Пункти {template} (Word) завантажуються одразу (див. Шаблони Word); кожен пункт Word має однорядковий опис під назвою. Видалити документ… наприкінці меню видаляє документ, за бажанням разом із розділами, які не використовує жоден інший документ (див. Список документів), і повертає до списку. Структура (Word)…, Правки (Word)…, Зміни (Excel)…, Вимоги (ReqIF)…, Дані документа (JSON)… і Друк або PDF… відкривають діалог Експорт із цим вибором; Усі експорти… відкриває його з вашим останнім вибором.
- Натисніть Видати ▾ → Усі експорти….
Відкривається Експорт.
- Виберіть, що експортувати, у полі Експортувати як. Варіанти мають назви “<вміст> (<формат>)” і згруповані за виходом: Word, Excel, CSV, вебсторінка, текст, обмін і друк.
- Задайте його параметри.
- Відредагуйте Ім’я файлу (до 99 символів).
- Натисніть Експорт.
Попередній перегляд показує перші 60 рядків звітів-таблиць. Для інших експортів він показує “Попередній перегляд доступний лише для експорту в таблиці. Виберіть експорт Excel.” Звіти використовують номери документа, а в базовій лінії — вміст базової лінії.
| Звіт | Вихідна величина | Параметри |
|---|---|---|
| Документ (Word) | Документ у Word (див. Вихід Word) | Шаблон Word (шаблон документа; вибір іншого заповнює параметри нижче з нього), Додати зміст, Глибина змісту від 1 до 6, Нумерація підписів (Рисунок 1, Таблиця 1, За розділами: Рисунок 3-1, Таблиця 3-1 або Вимкнено), Перелік рисунків і перелік таблиць (якщо документ має підписи), Заголовки всередині описів з’являються в змісті, Включити стовпці атрибутів, показані в документі, Додати зв’язані документи як додатки, Заповнити таблиці історії редакцій і затверджень із базових ліній. Типові значення беруться із шаблону; для Specification: зміст до рівня 3, проста нумерація підписів, переліки, стовпці (якщо показані), додатки й таблиці базових ліній увімкнено, заголовки вимкнено. Розмір і орієнтацію сторінки визначає шаблон. |
| Зміни (Excel) | Кожен доданий, вилучений і змінений елемент, атрибут і зв’язок між двома версіями | From (базова лінія; спочатку вибрано найстарішу), To (Поточна версія або базова лінія); без базової лінії — “Цей документ не має базової лінії. Спершу збережіть її.” |
| Таблиця (CSV) | Один рядок на елемент | Атрибути (у порядку стовпців) (типово Number, Name, Description і показані стовпці; також будь-який Relationship: {name}, що перелічує пов’язані елементи), Сортувати за: Ієрархічна, Number або Name |
| Коментарі (Excel) | Один рядок на кожен коментар до документа та його елементів, з автором коментаря | Включити Class, Name, Number і Description, Дата, Вирішено (усі ввімкнено) |
| Дані документа (JSON) | Документ для повторного імпорту | Безпосередньо пов’язані сутності (вимкнено), Коментарі (увімкнено), Базові лінії (вимкнено), Історія (вимкнено) |
| Структура (Word) | Лише заголовки, з нумерацією | Додати зміст (вимкнено) |
| Документ (Markdown) | Документ як заголовки й текст Markdown | немає |
| Документ (друк або PDF) | Діалог друку браузера; виберіть там “Зберегти як PDF” | немає |
| Правки (Word) | Документ із відстеженими змінами Word (див. Правки) | Від базової лінії (остання), Ціль (пізніша базова лінія або Поточна) |
| Зауваження щодо якості (Excel) | Дев’ять рядків на вимогу (по одному на критерій) з повідомленням і зеленим Yes або червоним No, а наприкінці — “Report score” | Інші атрибути, Включити Created On, Modified On і Global ID |
| Вимоги (ReqIF) | ReqIF XML з ієрархією та зв’язками traced to, satisfied by, verified by, satisfies, verifies і traced from усередині документа | немає |
| RSM (Excel) | Requirement → елементи satisfied by | Атрибути вимоги (Number, Name), Атрибути пов’язаної сутності (Class, Number, Name, Description) |
| RTM (Excel) | Requirement → елементи traced to | як RSM |
| RVM (Excel) | Requirement → елементи verified by | як RSM |
| RVTM (Excel) | Requirement → 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 у такому порядку:
- Титульна сторінка (якщо ввімкнено Титульна сторінка у параметрах сторінки або Титульна сторінка в налаштуваннях документа поставки), а інакше — назва й рядок курсивом із типом і “№ {number}”. З базової лінії рядок доповнюється “Базова лінія: {name} ({date})”. Повідомлення грифа (параметри сторінки) з’являється в рамці під назвою.
- Історія редакцій (Версія, Дата, Автор, Зміни): один рядок на кожну базову лінію документа, від найстарішої, до експортованої базової лінії включно.
- Перший рядок містить “Початкова базова лінія”. Наступні рядки містять “N додано, N вилучено, N змінено” або “Без змін”.
- Автор — творець базової лінії або її затверджувачі.
- Затвердження (Роль, Ім’я, Твердження, Дата) з останньої (або експортованої) базової лінії. Без записів про затвердження заплановані затверджувачі з налаштувань документа поставки отримують блок підпису: Роль, Ім’я, Підпис і Дата з порожніми рядками для підпису.
- Опис документа, потім зміст, Перелік рисунків і Перелік таблиць та розрив сторінки.
- Кожен елемент — як заголовок Word з його номером і назвою, потім його опис. Стилі Heading 1–Heading 6 відповідають глибині; глибші рівні залишаються Heading 6. Таблиця Атрибут/Значення перелічує вибрані стовпці, що мають значення.
- Додатки: кожен документ, зв’язаний вбудованим посиланням, починається з нової сторінки з “{document} Appendix” і його вмістом, на один рівень нижче.
Згенеровані таблиці можуть розміщуватися в розділі, а не на початку. Так буває, коли документ має розділ з однією з цих назв (їх використовують вбудовані шаблони):
- Історія редакцій: “Revision History” або “Document Revision History”.
- Затвердження: “Approvals”, “Approval”, “Sign-off”, “Signoff”, “Signatures” або “Signature”.
Підписи, переліки й перехресні посилання
- Підписи рисунків (підпис зображення, рисунок діаграми) мають вигляд “Рисунок 1: {caption}” під зображенням. Підписи таблиць (заголовок матричного блока, підпис таблиці) мають вигляд “Таблиця 1: {caption}” над таблицею.
- За розділами нумерує їх у межах кожного розділу верхнього рівня: “Рисунок 3-1” — перший рисунок у розділі 3. Таблиці без підпису не нумеруються.
- Номери є полями Word SEQ, а Перелік рисунків і Перелік таблиць — полями Word за підписами. Вони з’являються, лише коли документ має підписи рисунків або таблиць. Доки Word не оновить поля, переліки показують підписи без номерів сторінок.
- Кожен заголовок, підпис рисунка й підпис таблиці має закладку. Перехресне посилання в описі стає полем Word REF на закладку, тож після оновлення полів у Word воно показує поточний заголовок (“3.2 Frost Warning”) або позначку (“Рисунок 2-1”). Перехресне посилання на елемент, якого немає в експортованому документі, зберігає свій текст.
- Заголовки всередині описів з’являються в змісті перетворює заголовки в описі на справжні заголовки Word на один рівень нижче елемента. Якщо вимкнено, вони залишаються жирними абзацами.
Налаштування результату
Видати ▾ → Налаштування документа поставки… містить дані, які зазвичай показує контрактний документ поставки. Застосувати зберігає їх; ⌘Z / Ctrl+Z відміняє це одним кроком.
| Поле | Де з’являється |
|---|---|
| Нумерація | Номери моделі (власні номери елементів) (типово) або Номери документа (зберігаються лише в цьому документі) (див. Нумерація документа). |
| Титульна сторінка | Вмикає титульну сторінку (той самий перемикач, що й Титульна сторінка у параметрах сторінки). |
| Версія, Підготував | Титульна сторінка й колонтитул (ті самі поля, що й у параметрах сторінки). |
| Організація, Підготовлено для, Номер контракту, Пункт CDRL, Номер DID | Титульна сторінка. Пункт CDRL також з’являється в нижньому колонтитулі. |
| Логотип | Верх титульної сторінки. PNG, JPEG або GIF, до 400 КБ. |
| Повідомлення на титульній сторінці | Рамка внизу титульної сторінки, наприклад положення про розповсюдження. Якщо порожньо — повідомлення грифа з параметрів сторінки. |
| Верхній і нижній колонтитули | Типово ввімкнено. Верхній колонтитул показує “{number}, Версія {version}” і назву; нижній — дату, “Сторінка X з Y” і “CDRL {item}”. Потрібен номер документа або версія. |
| Заплановані затверджувачі | Роль та ім’я кожного затверджувача. Вони отримують рядки для підпису, доки базова лінія не зафіксує затвердження. |
Номер документа — це поле № поруч із назвою документа.
Формат сторінки
- Сторінка шаблону Word: US Letter або A4, книжкова чи альбомна, з верхнім і нижнім полями 1 дюйм і бічними полями 0,875 дюйма.
- Calibri 11 пт.
- Справжні стилі заголовків, тож область навігації та зміст Word працюють.
- Рядки заголовків таблиць затінено, і вони повторюються на кожній сторінці.
- Банери сторінки (грифи) повторюються у верхньому й нижньому колонтитулах кожної сторінки, включно з титульною.
- З титульною сторінкою файл має три розділи: титульну сторінку (лише банери, без колонтитула й номера сторінки), вступну частину (історія редакцій, затвердження, опис, зміст і переліки, нумерація i, ii, iii) і основну частину (нумерація від 1; “Сторінка X з Y” рахує основну частину).
- Word пропонує оновити поля, коли відкриває файл. Доти зміст показує “Клацніть правою кнопкою й виберіть “Оновити поле”, щоб побудувати зміст.”
Перетворення форматованого тексту
- Зберігаються: жирний, курсив, підкреслення, закреслення, надрядковий і підрядковий індекси, вбудований код (Consolas), виділення, колір тексту й вебпосилання.
- Заголовки всередині описів стають жирними абзацами або, з параметром вище, заголовками Word.
- Списки стають абзацами з відступом і “•” або “1.”.
- Блоки коду стають затіненими рядками моноширинним шрифтом. Цитати стають курсивом із відступом.
- Таблиці зберігають об’єднані стовпці та затінення заголовків.
- Зображення PNG, JPEG і GIF вбудовуються шириною приблизно до 6,5 дюйма, з альтернативним текстом як описом зображення. Зображення SVG і WebP у файли Word не потрапляють.
Правки
Видати ▾ → Правки (Word)… записує документ із відстеженими змінами Word. Виберіть Від базової лінії і Ціль (пізніша базова лінія або Поточна). Правки (Word) у Порівняти версії робить те саме для двох показаних там версій.
- Файл починається з таблиці Зведення змін: кожна зміна зі звіту про зміни, включно з атрибутами, мітками й зв’язками.
- Далі — документ у цільовій версії: доданий елемент є відстеженою вставкою; вилучений елемент — відстеженим видаленням, розміщеним після елемента, що йшов перед ним; змінена назва чи опис показує видалені й вставлені слова.
- Прийміть або відхиліть зміни на вкладці Word Рецензування. Змінені описи з’являються як звичайний текст; незмінені зберігають форматування.
- Зміни приписуються творцеві цільової базової лінії або, для Поточна, вам.
Друк / PDF
Друк або PDF… друкує сторінку документа засобами браузера. Банери друкуються вгорі й унизу кожної сторінки. З колонтитулом (налаштування документа поставки) “{number}, Версія {version}” і назва повторюються вгорі кожної сторінки, а дата й пункт CDRL — унизу. У збірці кожна частина починається з нової сторінки. Номери сторінок, зміст і нумерація підписів є лише у виході Word.
Коментарі
Коментуйте елемент на його панелі сутності в інспекторі (частина “Обговорення”). Перевірити ▾ → Коментарі або 💬 n відкритих коментарів в основному написі показує коментарі в інспекторі:
- Кожен коментар до документа та його елементів, згрупований за елементом, з “(N відкритих)”. Відповіді мають відступ під коментарем, на який відповідають. Клацніть назву елемента, щоб вибрати його.
- Показати вирішені включає вирішені коментарі.
- Кожна гілка обговорення має Вирішити/Відкрити знову на першому коментарі, а кожен коментар — × (видалити).
- Щоб прокоментувати сам документ, введіть текст у Коментувати цей документ… і натисніть Додати коментар.
- × угорі закриває коментарі; вибір елемента натомість показує його панель сутності.
- Рядок із невирішеними коментарями показує 💬 n; клацніть його, щоб відкрити обговорення елемента.
- Вирішуйте, відкривайте знову й видаляйте коментарі в будь-якому з цих місць.
- Коментарі (Excel) в Усі експорти… збирає їх.
Див. Коментарі та рецензування.
Збірки
Збірка поєднує інші документи. Нові збірки, створені на сторінці Рецензування або командою Створити пакет рецензування, мають мітку Review Package; пакети, створені раніше, мають мітку Compilation і працюють так само. Див. Рецензування.
Вставити документ… додає документ. Ця команда є в Написати ▾ → Вставити ▸ і в меню + Створити ▾.
- Вона перелічує документи, які ще не включено.
- Вставлений документ з’являється як елемент верхнього рівня, з власним вмістом під ним. Сповіщення показує “Вставлено: {document}”.
- Якщо інших документів немає, ви бачите “Немає інших документів для вставлення.”
Згенеровані розділи
Вставити згенерований розділ… (у Написати ▾ → Вставити ▸ і меню + Створити ▾) додає частину, вміст якої перебудовується з моделі щоразу, коли збірку показують або експортують.
| Вміст | Що містить частина |
|---|---|
| Матриця або звіт про тестування… | Вставити відкриває Вставити матрицю; виберіть там матрицю (або звіт про тестування) та її область. Область Збірка (усі частини) охоплює кожну частину. Залиште Назва розділу порожнім, щоб використати назву матриці. |
| Список скорочень | Таблиця тверджень із міткою Acronym (Number, Name), відсортована за номером. |
| Таблиця запиту | Таблиця сутностей, що відповідають полю Запит, зі Стовпці, які ви перелічите (назви атрибутів через кому). |
Частина отримує номер після останньої частини, тож документи-частини зберігають свої номери. ⌘Z / Ctrl+Z вилучає її одним кроком. Без назви ви бачите “Введіть назву розділу.”; таблиця запиту без запиту чи стовпців показує “Введіть запит і щонайменше один стовпець.”
Збірка у Word
Експорт збірки у Word експортує кожен елемент верхнього рівня як частину:
- Заголовок частини має вигляд “Частина A: {document}” (Heading 1), з рядком для типу документа, номера й закріпленої базової лінії.
- Номери розділів усередині частини отримують літеру частини: “A.1 Scope”, “B.1 Scope”. Жоден номер розділу не повторюється.
- Кожна частина після першої починається з нової сторінки.
- З підписами За розділами рисунки в частині B мають вигляд “Рисунок B-1”.
Налаштування документа поставки… у збірці додає Частини компіляції:
| Налаштування | Варіанти |
|---|---|
| Позначення частин | Частина A, Частина B, … (типово), Том 1, Том 2, …, Додаток A, Додаток B, … або Без позначень частин |
| Номери розділів | Окремо для кожної частини, з літерою або номером частини (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 розділів. Шаблони, збережені в одному проєкті, не пропонуються в інших проєктах: збережіть шаблон в організації або збережіть його знову в іншому проєкті.
Пов’язане
- Вимоги: атрибути, перевірки якості, TBD/TBR, зв’язки для перевірки, затвердження та параметри імпорту вимог.
- Простежуваність: зв’язування вимог із функціями, активами й тестами.
- Імпорт і експорт: усі формати імпорту та експорту.
- Модель і база даних: сутності, інспектор, мітки, історія та блокування.
- Розширення схеми: власні типи документів і атрибути.
- Довідка: Документи, Редактор форматованого тексту, Пошук скорочень, Написання й простеження вимог.