Редакційна політика

Ця політика пояснює, як команда документації ConnectiveOne готує, перевіряє та виправляє публічні матеріали.

Джерела

Для продуктових тверджень використовуються джерела, які можна перевірити:

  1. поточний інтерфейс і фактична поведінка підтримуваної версії продукту;
  2. специфікації функції та підтвердження відповідальної продуктової команди;
  3. перевірені сценарії підтримки без даних конкретного клієнта;
  4. офіційна документація постачальника — для зовнішніх інтеграцій;
  5. публічні умови ConnectiveOne — для питань підтримки, приватності й договорів.

Матеріали окремого клієнта, приватні панелі, тимчасові файли та внутрішня документація розробників не є публічними джерелами й не повинні потрапляти в статті.

Перевірка перед публікацією

Перед публікацією автор перевіряє:

  • назви кнопок, полів і меню за поточним інтерфейсом;
  • передумови, права доступу, результат і типові помилки;
  • внутрішні та зовнішні посилання;
  • відповідність української та англійської версій;
  • відсутність секретів, персональних даних і внутрішніх назв клієнтів.

Зміст проходить окрему редакторську перевірку. Для змін із високим ризиком потрібне підтвердження власника функції або інженера.

Використання AI

AI може допомагати зі структурою, мовною редактурою, пошуком прогалин і підготовкою чернетки. AI не є джерелом правди та не публікує матеріал самостійно.

Людина з команди:

  • перевіряє кожне фактичне твердження за доступним джерелом;
  • видаляє вигадані параметри, посилання та обіцянки;
  • перевіряє, що текст не розкриває секрети або приватні дані;
  • затверджує фінальну версію.

Виправлення

Якщо ви знайшли неточність, скористайтеся кнопкою «Повідомити про помилку» на сторінці. Додайте очікуваний результат і, якщо це безпечно, назву елемента інтерфейсу. URL, мова та ревізія сторінки додаються автоматично.

Команда перевіряє повідомлення за актуальною версією продукту. Підтверджена помилка виправляється в статті; якщо змінилася сама функція, команда також перевіряє пов’язані інструкції та рольові путівники.

Дивіться також «Про цю документацію» і «Безпека та приватність».