Зміст
Пишіть для звичайної, не технічною аудиторії
Ми хочемо зробити наші статті придатними для використання всіма нашими користувачами, а не тільки просунутими. Це означає, що ми пишемо в першу чергу для звичайних людей, а не тих, які дуже добре знайомі з комп'ютерною технікою і термінологією. Припускайте, що людина, для якого ви пишете, не знає як поміняти настройки або додати кнопку на панель інструментів без покрокової інструкції. Крім того, ми повинні вважати, що ця людина не змінював налаштування за замовчуванням в програмі або операційній системі.
Виберіть гарна назва
- Довжина назви: Сторінка результатів пошуку Google відображає до 70 символів. Ваше назва може бути довшим, якщо це необхідно, але переконайтеся, що ваші важливі ключові слова увійшли в перші 70 символів.
- Заголовні букви: З великої літери в заголовку повинні бути написані перше слово і власні імена, а не кожне довге слово (останнє можливе лише в англійській мові, де це називається «headline style»).
- Не використовуйте двокрапку в назві статті, так як це робить неможливим створення вікі-посилання до цієї статті (bug 749835).
- Переконайтеся, що в назві статті немає зайвих пробілів. Через них теж не працюють вікі-посилання.
- Спробуйте змінювати способи іменування статей. Не використовуйте одні й ті ж дієслова або фрази в кожній назві.
- Намагайтеся не використовувати дієслова теперішнього часу.
Пам'ятайте, що повне пояснення не потрібно включати в назву. Ви можете використовувати зведення, щоб дати користувачеві додаткову інформацію про те, що знаходиться в цій статті.
виправте посилання
Статті також мають «відношення» принаймні до одного продукту. Вони також належать до однієї головної «Темі» і можливо до «підтеми».
Ключові слова
Поле ключові слова в статті можна використовувати для поліпшення результатів пошуку по SUMO. Тим не менше, воно повинно використовуватися тільки при певних обставинах, так як зловживання ним може реально зашкодити пошуку. Нам слід рідко використовувати ключові слова. Більш детальну інформацію можна знайти в статті When and how to use keywords to improve an article's search ranking
Напишіть хорошу зведення пошуку
Зведення для статті з інструкцією повинно включати в себе теми, порушені в статті. Для статті з усунення несправностей вона повинна спробувати включити симптоми. Крім того, зведення повинно дотримуватися наступних правил:
Зробіть ваші тексти цікавими
База знань - це сховище технічної інформації про роботу в прикладному програмному забезпеченні Mozilla. У документації перераховані функції їх різних можливостей, процедури з усунення несправностей та інструкції щодо вирішення типових проблем. Отримати доступ до документації можна через функцію пошуку на кожній сторінці, або ж ви можете просто кинути свій комп'ютер в інший кінець кімнати, де єдинороги за допомогою сили веселки перетворять його в магічну печеньку, з'ївши яку, ви станете комп'ютерним ніндзя 80-го рівня.
Тепер прокинулися? Добре.
Цей параграф виглядає як нудна лекція, як мінімум до появи єдинорогів. Використання гумору і / або емоцій (СЮРПРИЗ!) Є однією з технік, за допомогою якої ми можемо залучити людей. Наведені нижче техніки допоможуть сконцентрувати увагу, відтворюючи ефект живого спілкування. Коли ми їх використовуємо, інформацію стає простіше зрозуміти і запам'ятати.
Напишіть гарне вступ
Разом з назвою і змістом вступ допоможе користувачеві швидко визначити, зайшов він в потрібне місце.
- Для навчальних або how-to-статей: Дайте короткий опис того, яка користь може бути залучена з статті.
- Для оглядових статей: Дайте короткий опис функцій, наведених у статті.
- Для статей «Усунення неполадок»: Дайте короткий опис проблеми та її симптомів.
Гарне вступ зазвичай може послужити і як хороша зведення результатів пошуку. Найчастіше ви можете просто її скопіювати в «Зведення результатів пошуку» і все готово.
Ефективно організуйте статтю
Основною ідеєю є вибудовування необхідних навичок щодо виконання інструкцій від простих до складних, щоб інформація, потрібна більшості людей, перебувала ближче до початку. Тобто просте або типове рішення повинно бути на початку, а складне або специфічне - в кінці.
Використовуйте описові назви заголовків
Наші статті зазвичай комплексні, тому дуже важливо використовувати описові заголовки, щоб допомогти людям знайти ту частину статті, яка їм потрібна. Погляньте на зміст. Чи працює це разом з введенням, щоб дати вам хороший короткий огляд сфери застосування статті?
Зробіть покрокову інструкцію легкої у використанні
Основна ідея в покрокових інструкціях - включити всі кроки, необхідні для виконання завдання. Якщо, наприклад, для переходу до наступного кроку після вибору настройки необхідно натиснути на «OK», - перевірте, що натискання на «OK» у вас включено як частину поточного кроку. І ще кілька порад:
- Завжди є кілька шляхів для досягнення мети. Намагайтеся вибирати найбільш доброзичливий до користувача - використовуючи графічний користувальницький інтерфейс і меню, коли це можливо.
- Використовуйте повні пропозиції, коли вказуєте, як дістатися до того чи іншого пункту меню.
- Даючи інструкції, вказуйте очікуваний результат (наприклад: «Клацніть" OK "і вікно закриється»).
Кілька порад від спільноти SUMO
Як ми говорили раніше, при написанні статей краще використовувати активний, розмовний стиль. Таким чином, замість того, щоб писати «Якщо призначені для користувача закладки були втрачені ...», варто написати «Якщо у вас пропали закладки ...». Нижче наведено ще кілька загальних порад з приводу написання статей:
Завжди використовуйте терміни так, як вони відображаються в інтерфейсі Mozilla. наприклад:
Загальні комп'ютерні терміни:
- Інтернет з великої літери
- Веб-сайт - пишеться через дефіс.
Посилання на mozilla.org не повинні містити вказівку локалі:
Пишіть з великої літери:
- Власні імена
- Перше слово в реченні
- Абревіатури і акроніми, крім тих випадків, коли вони повинні бути малими
- Перше слово в списках
- Назви клавіш на клавіатурі
- Перше слово пропозиції після двокрапки
- Перше слово в заголовку або назві
У нас є спеціальні візуальні стилі для ряду елементів, які можуть бути отримані шляхом додавання спеціальної вікі-розмітки навколо об'єкта (див. Найбільш поширені стилі в Markup cheat sheet).
Так само у нас є спеціальний тег - - який дозволяє вказати інформацію для опредёленних версій Firefox або певних операційних систем. Наприклад, ви можете вказати один набір інструкцій для тих хто використовує Windows і інший для тих, хто використовує Mac OS X (див. Як використовувати For).
Отримайте підтримку для іншої платформи: Налаштувати цю статтю