Перш ніж почати
- Список людей, які читатимуть, редагуватимуть і адмініструватимуть вікі.
- Документація для обраної вікі та її цільової версії.
- Місце для робочих нотаток і окреме контрольоване місце для облікових даних відновлення.
1. Опишіть завдання, яке виконуватиме вікі.
Почніть з одного речення: «Учасники використовують цю вікі, щоб знайти актуальні інструкції для проведення нашої спільної майстерні». Ця гіпотетична мета вужча, ніж «розмістити все онлайн». Вона передбачає керований початковий набір: процедури відкриття, нотатки про обладнання та рішення з зустрічей. Особисті контактні дані та облікові дані доступу потребують окремих рішень; зручне поле пошуку не є причиною їх збирати.
Перелічіть, що читач має виконати, наприклад, знайти найновішу процедуру, відкрити діаграму за посиланням і дізнатися, хто відповідає за застарілу сторінку. Виберіть невеликий зразок реального вмісту, щоб згодом оцінити застосунок. Не робіть висновок про потреби в пам’яті лише з кількості учасників: завантаження, індексування, розширення та одночасна робота можуть змінити навантаження.
2. Створіть одну сторінку для залежностей.
Використайте цей приклад як початкову карту, а потім замініть кожне припущення структурою вибраного застосунку. «Власник» означає особу, яка може пояснити й відновити цей компонент, не обов’язково ту, яка його встановила.
| Частина | Що має бути в записнику | Питання відновлення |
|---|---|---|
| Вебзастосунок | Версія, розташування конфігурації та власник служби | Чи може інший супровідник відтворити ту саму версію? |
| База даних | Рушій, версія та метод резервного копіювання | Який знімок відповідає файлам? |
| Зображення та вкладення | Шляхи зберігання та оцінка зростання | Чи відкриває відновлена сторінка свою діаграму? |
| DNS і HTTPS | Власник облікового запису домену та метод сертифіката | Хто може відновити доступ без вікі? |
| Електронна пошта та запланована робота | Відправник, розклад і відповідальний за збої | Що все ще працює, коли доставка не вдається? |
Так само запишіть пошук: чи він є частиною застосунку, індексом, який можна відбудувати, чи окремим сервісом? Не припускайте, що індекс можна відкинути, доки документація застосунку не підтвердить, як його відбудувати.
3. Розділіть читання, редагування та адміністрування.
Для прикладу з майстерні: учасники читають процедури, невелика група редакторів змінює їх, а двоє уповноважених супровідників керують обліковими записами. Адміністрування хостингу — окрема відповідальність. Запишіть, хто може публікувати сторінку, завантажувати файли, експортувати вміст і змінювати дозволи. Вирішіть, як учасник, який вибуває, втрачає доступ і хто перевіряє сторінки, які він супроводжував.
Правила дозволів застосунку можуть поєднуватися несподіваним чином. Наприклад, BookStack об’єднує можливості в межах ролей користувача та підтримує перевизначення на рівні вмісту; дозволи полиці не каскадуються автоматично на її книги. Перевіряйте фактичний результат за допомогою звичайних облікових записів учасників, а не лише облікового запису адміністратора. Ролі та дозволи BookStack.
4. Тримайте набір для відновлення разом.
Кожному набору резервних копій укажіть дату, версію застосунку та примітку про те, які копії бази даних і файлів належать одна до одної. Зберігайте інструкції в місці, доступному навіть якщо вікі вийде з ладу. Зберігайте секрети у відповідному сховищі секретів; нотатка має визначати, хто може їх отримати та де, не відтворюючи їхніх значень.
Як конкретний приклад застосунку: рекомендації BookStack щодо резервного копіювання охоплюють записи бази даних, конфігурацію, завантажені зображення, вкладення та будь-які теми. Його конфігурація містить ключ, важливий для зашифрованих даних застосунку, тож копіювання лише видимих сторінок пропускає важливий матеріал для відновлення. Дотримуйтеся власної процедури застосунку для вашої версії. Резервне копіювання та відновлення BookStack.
Виберіть незалежне місце призначення для копій і призначте конкретну особу для перевірки, що воно залишається доступним.
5. Узгодьте процедуру, яку група зможе підтримувати.
Виберіть інтервал перевірки, який супровідники справді зможуть витримати. Під час кожної перевірки звертайте увагу на невдалі резервні копіювання, очікувані оновлення застосунку, зростання вкладень і облікові записи, яким більше не потрібен доступ. Тримайте нагальні оновлення безпеки поза цим розпорядком, коли вони потребують негайнішої уваги. Записуйте наступну дію та її виконавця, а не збирайте дедалі довший список розпливчастих занепокоєнь.
У прикладі група редакторів також перевіряє короткий список «потребує перегляду». Процедуру для обладнання без власника слід помітно позначити для перегляду, а не тихо залишати такою, що виглядає авторитетно. Перед значущим оновленням занотуйте робочу версію, інструкції застосунку щодо міграції та точку відновлення, яку ви плануєте використати, якщо перевірка не вдасться.
6. Перевірте корисний шлях, потім зафіксуйте прогалини.
На окремій тестовій копії попросіть другого супроводжувача знайти зразкову сторінку, відкрити її вкладення, зробити дозволене редагування та спробувати дію, яку його обліковий запис не повинен дозволяти. Перевірте результат пошуку після зміни вмісту. Зафіксуйте очікувані та спостережені результати; успішний вхід сам по собі не доводить, що вікі придатна для використання або правильно обмежена.
Якщо вкладення відсутнє, порівняйте його місце зберігання та набір резервних копій, перш ніж редагувати записи бази даних. Якщо дозволи відрізняються, перевірте ролі облікових записів і перевизначення вмісту, перш ніж розширювати доступ. Якщо застосунок не запускається, зупиніть вправу та зафіксуйте невідповідність версії або конфігурації. Це кроки приймання, які потрібно виконати, а не звітування про тестування інфраструктури Hoszen.
7. Залиште шлях поза увагою.
Виберіть один репрезентативний розділ для експорту та запитайте, чи зможе хтось прочитати його без оригінальної вікі. Розглядайте цю читабельну копію як окремий результат від набору відновлення: вона може не зберігати облікові записи, дозволи або налаштування застосунку. Домовтеся, хто підтримуватиме цю вихідну копію, коли вміст змінюється.
Ваш готовий план має розміщуватися поруч із реєстр сервісів, а не замінювати його. Продовжуйте з портативна папка експорту та навчальне відновлення. Мета — вікі, яку інша уповноважена особа може зрозуміти та відновити; жоден застосунок не встановлюється цим посібником.
Документація до цієї нотатки
Використовуйте документацію для тієї версії, яку ви насправді запускаєте. Ці приклади є матеріалом для планування, а не записом про тестування на VPS Hoszen.