Помічники
Помічники
Створено:
2 тижні тому
Створено:
2 тижні тому
Перш ніж вносити будь-які зміни до статей бази знань підтримки Mozilla, важливо розуміти, що ми по-різному ставимося до робочого процесу з контентом залежно від значущості змін.
Усі нові статті та значні зміни до статей підтримки мають супроводжуватися запитом на контент через Bugzilla (дивіться How to submit a SUMO Knowledge Base content request), тоді як незначні зміни можна надсилати безпосередньо в статті без запиту на контент.
Що кваліфікується як незначні зміни
Керівний принцип: Незначні оновлення — це зміни на рівні обслуговування, які суттєво не змінюють керівництво статті, напрямок усунення несправностей, структуру чи мету, і зазвичай не вимагають перевірки продукту або ширшої координації із зацікавленими сторонами продукту.
Ось що ми вважаємо незначними змінами:
- Виправлення невеликих одруків
- Видалення непотрібних пробілів
- Виправлення орфографічних, граматичних або пунктуаційних помилок
- Виправлення форматування вікірозмітки (заголовки, маркери, нумерація, інтервали, відступи)
- Оновлення невеликих фактичних деталей (наприклад: номери версій, мітки кнопок або меню) без переписування розділів
- Оновлення розділів і заміна їх наявними шаблонами без зміни початкового контексту
- Виправлення застарілого або непідтримуваного вмісту, включно з оновленнями для обслуговування, як-от додавання або видалення тегів версій, без суттєвих змін у базових інструкціях
- Видалення вмісту та розмітки, пов’язаних із версіями продукту, які більше не підтримуються
- Покращення читабельності або чіткості за допомогою невеликих уточнень інструкцій, спрощених формулювань або включення візуальних підказок для доступності (наприклад: додавання значків і посилань на меню) без суттєвої зміни керівництва чи структури статті
- Оновлення непрацюючих посилань, посилань на перейменовані статті бази знань або посилань з тим самим цільовим вмістом
- Налаштування тону відповідно до стандартів вмісту підтримки Mozilla
- Заміна застарілих знімків екрана інтерфейсу користувача оновленими версіями (максимум 3 знімки екрана)
- Оновлення ключових слів
- Додавання або оновлення підсумку для пошуку
Примітка: Ми очікуємо, що невеликі зміни будуть подані разом в одній редакції, а не в кількох.
Що кваліфікується як значні зміни
Керівний принцип: Значні оновлення — це зміни, які суттєво впливають на керівництво для користувача, структуру статті, вплив на локалізацію або вимагають міжфункціональної координації з внутрішніми чи зовнішніми зацікавленими сторонами.
Значні зміни у статтях підтримки Бази знань (БЗ) вимагають запиту у Bugzilla для полегшення координації із зацікавленими сторонами продукту, забезпечення точності вмісту, відстеження прогресу та підтримки міжфункціональної співпраці.
Примітка: Якщо технічне підтвердження зміни вже існує в загальнодоступній документації Mozilla, як-от Bugzilla, примітки до випуску чи допис у блозі, і не потрібен додатковий внесок від продукту, зазвичай немає потреби створювати квиток у Bugzilla, якщо тільки вміст не пов’язаний з готовністю до випуску.
Нижче наведено зміни, які ми вважаємо значними:
- Створення нової статті
- Зміни, що вимагають перевірки від зацікавлених сторін продукту або тісної координації з ними, зокрема:
- Оновлення, пов’язані з готовністю до випуску
- Суттєві доповнення вмісту (наприклад, нові інструкції, поширені запитання або кроки з усунення несправностей)
- Заміна застарілих знімків екрана або додавання нових знімків екрана понад 3 зображення
- Суттєві зміни, що впливають на керівництво для користувача або структуру статті, які вимагають перегляду командою з контенту, зокрема:
- Видалення наявного розділу
- Значне переписування абзаців або розділів
- Масштабні зміни форматування або структури (наприклад, реорганізація кількох розділів або зміна потоку статті)
- Зміна обсягу або мети статті
- Оновлення, додавання або видалення скринкастів, GIF-файлів або відео
- Переписування або перейменування заголовків розділів, що може вплинути на якірні посилання або навігацію по статті
Примітка: Щоб зробити процес перевірки більш керованим, значні зміни слід подавати як окремі редакції. Якщо подано одну велику редакцію, її розгляд може бути відкладено, і вас попросять розбити її на менші частини та подати повторно.
Щоб дізнатися більше про внесок у Базу знань, перегляньте How to contribute to the Knowledge Base.
