Про цю документацію
Це офіційна документація ConnectiveOne для операторів, супервайзерів, адміністраторів та інтеграторів. Вона допомагає виконувати робочі задачі в інтерфейсі платформи й розуміти основні поняття продукту.
Хто відповідає за документацію
Матеріали підтримує команда документації ConnectiveOne разом із представниками продукту, підтримки та розробки:
- технічні автори структурують і редагують матеріали;
- власники продукту та розробники підтверджують поведінку функцій;
- команда підтримки додає типові питання й проблемні сценарії;
- редактор перевіряє зрозумілість, безпеку та відповідність стилю.
Персональні авторські сторінки не використовуються: відповідальність за актуальність несе команда, а не окрема людина.
Докладніше про організацію читайте на сторінці «Команда ConnectiveOne».
Що входить до документації
Портал містить:
- навчальні маршрути для першого знайомства з роллю;
- покрокові інструкції для конкретних задач;
- пояснення принципів роботи функцій;
- довідники параметрів, статусів і термінів;
- нотатки про зміни у версіях продукту.
У документації немає внутрішніх процедур розробки, приватних даних клієнтів, конфігурації окремих інстансів або гарантій, що не зафіксовані в договорі.
Мови
Документація доступна українською та англійською. Перемикач Languages у шапці відкриває доступну мовну версію. Якщо перекладу конкретної сторінки ще немає, перейдіть до головної сторінки іншої мови та скористайтеся пошуком.
Як ми оновлюємо матеріали
- Опис нової або зміненої функції оновлюється разом із підготовкою відповідного релізу або невдовзі після нього.
- Виправлення фактів, зламаних посилань і незрозумілих кроків публікуються після перевірки.
- Сторінки без актуального сценарію об’єднуються, перенаправляються або видаляються.
- Кожна сторінка має технічну ревізію. Вона автоматично додається до повідомлення через «Повідомити про помилку».
- Кожна опублікована стаття також доступна через «Відкрити Markdown» і «Завантажити Markdown». HTML і Markdown використовують одне джерело.
Як повідомити про проблему
На будь-якій статті натисніть «Повідомити про помилку», опишіть проблему та відкрийте Client Portal. До заготовки автоматично додаються URL, мова й ревізія сторінки. Не вставляйте в повідомлення паролі, токени або персональні дані клієнтів.
Докладніше про перевірку матеріалів читайте в редакційній політиці, про безпечні приклади — у розділі «Безпека та приватність», а про звернення та оновлення щодо інцидентів — у розділі «Підтримка та статус сервісу».