mozilla
Your Search Results

    Как помочь

    Существует множество способов, которыми Вы можете внести свой вклад в Сообщество Разработчиков Mozilla, причём некоторые из этих способов даже не требуют умения писать. На этой странице приведён достаточно подробный обзор всех областей, в которых нужна помощь, а также ссылки на списки конкретных насущных задач. Независимо от того, являетесь ли Вы программистом-любителем, или разработчиком ядра Firefox, или одним из тех веб-разработчиков, у которых миллионы последователей в Twitter, Вы найдете наиболее подходящий для Вас способ улучшить MDN.

    Чем я могу помочь?

    Перечислим некоторые конкретные сферы различных видов помощи, которую Вы можете оказать MDN по мере Ваших способностей и желания.

    Сообщить о проблеме

    В процессе чтения MDN всегда есть вероятность заметить, что  где-то что-то написано неверно или не так, как хотелось бы: например, отсутствие какого-либо контента либо ошибки в нём, непонятное, запутанное изложение, плохое форматирование, не работающие примеры кода и т.д. и т.п. Поскольку MDN теперь представляет собой ничто иное, как Wiki, то лучший вариант исправить замеченные Вами ошибки и/или неточности в контенте - исправить их сразу же самостоятельно. Впрочем, в жизни всякое бывает, может статься и так, что, обнаружив ошибку/неточность, Вы, тем не менее, пока что сами не знаете правильного решения/варианта, может статься, что Вы (не дай Бог!) в данный момент спешите к врачу и т.п. и т.д. В таком случае имеет смысл описать проблему, чтобы кто-то другой смог с ней разобраться.

    Сообщение о проблеме в документации, как и о всех прочих проблемах в Mozilla, делается путём баг-репорта в Bugzilla:  documentation request bug. Удобные для заполнения формы баг-репорта позволят Вам сообщить всю необходимую информацию для того, чтобы мы смогли приступить к исправлению указанного Вами недостатка.

    Впрочем, поскольку наша штатная команда технических писателей сильно занята, в большинстве случаев наиболее быстрым решением проблемы будет её самостоятельное исправление...

    Исправить ошибку

    Одна из самых простых вещей, которой Вы можете нам сильно помочь - это редактирование существующего контента. Если Вы заметили какую-либо ошибку, исправьте её! Если Вам кажется, что что-то изложено не совсем понятным языком, напишите лучше. Мы обожаем, когда читатели исправляют наши опечатки и даже таким образом улучшают MDN, ведь именно внимание к любым мелочам в тексте создаёт в итоге великолепное содержание!

    Несколько полезных ссылок:

    Добавить или обновить метки

    Метки страниц помогают систематизировать и каталогизировать информацию, выявлять страницы, требующие особого внимания, а также позволяют находить страницы с неактуальной информацией и помечать их как устаревшие или даже как подлежащие удалению. Поэтому крайне важно, чтобы на всех страницах документации всегда был актуальный, хороший набор меток - и в этом можете помочь именно Вы!

    Вашего вмешательства могут потребовать несколько видов данной проблемы:

    Меток нет вообще
    Каждая статья должна иметь как минимум одну метку, хотя рекомендуется более одной. Как правило, каждая статья должна иметь как минимум метки "category" и "topic". Зачастую необходимы и другие метки, однако, если Вы сможете помочь нам в том, чтобы каждая статья имела хотя бы необходимый вышеуказанный минимум меток, Вы уже станете настоящим героем технической документации!
    Метки неверны
    Если Вы читаете статью о HTML, а у неё метка "JavaScript", - это тот самый случай! Аналогично, если статья о внутреннем устройстве Mozilla помечена как "Web", - это тоже тот самый случай. Удалите эти метки (и добавьте правильные, если отутствуют). К этому типу проблемы относятся и опечатки в метках. Напрмер: "JavaScrpit" или "Javascript" (хотя последний вариант написания и будет учтён при поиске, так как метки нечувствительны к регистру, он явно написан с ошибкой!).
    Недостаточно меток
    Если у статьи уже есть какое-то количество меток, но их набор не полностью покрывает тематику статьи, не стесняйтесь добавить недостающие метки. Например, вы читаете какую-либо страницу из раздела "JavaScript reference", которая снабжена корректной, но единственной меткой "JavaScript". Поскольку это страница ссылок, у неё должна быть и метка "Reference". Она сама напрашивается на добавление!
    Слишком много меток
    Эта коварная разновидность проблемы - самая отвратительная: некоторые веб-паразиты любят погадить в метках, оставляя после себя что-то типа "Софт на халяву!" или "Превед я пасмарел тваю строницу и хачю папросит тибя мне памоч с такой фигней что у миня пастояна флешка тупит". Подобные сорняки нужно немедленно выпалывать!

    При обнаружении одной (или более) из указанных проблем Вы можете помочь, залогинившись в MDN, затем кликнув на кнопку "Edit" в верхнем правом углу окна MDN. После загрузки редактора прокрутите страницу в самый низ, где расположен tag box. Подробную информацию по интерфейсу рубрикатора см. "The tags box" в MDN editor guide.

    Добавить или отредактировать контент

    В MDN всегда найдётся, что добавить или поправить. Будь то свеженаписанная документация по какому-либо новейшему API или же правки в старой документации после незначительных изменений в старом добром API, - всегда найдётся возможность приложить Ваши силы в этом направлении.

    Редактирование существующей страницы

    Для редактирования просто нажмите кнопку "Edit" в правом верхнем углу страницы. Откроется WYSIWYG-редактор для редактирования контента. Информацию по работе с этим редактором и системой макросов, используемой нами для автоматического построения и форматирования контента страниц, см. в MDN editor guide.

    Существует масса поводов отредактировать существующую страницу:

    • Вы заметили ошибку или опечатку.
    • Вы испытываете жгучее желание описать какую-либо тему более понятным языком.
    • Вы хотите поправить неряшливое форматирование страницы.
    • API изменилось и нужно привести его документацию в соответствие.
    • Вы хотите добавить информацию о различном поведении данного API в различных броузерах.
    • Вы хотите добавить пример кода или улучшить существующий. См. Добавить пример кода ниже.
    • Статья представляет собой "заглушку" или же в ней отсутствуют важные детали.

    Добавление новой страницы

    Это воистину великое свершение! После создания новой страницы в MDN весь Web полюбит Вас. Есть ряд очевидных поводов для создания новой страницы, включая документирование ещё никем не документированного API, либо добавление нового учебника или руководства.

    Новую страницу в MDN можно создать несколькими способами после того, как Вы залогинились:

    Ссылка на несуществующую страницу
    В процессе сёрфинга по MDN Вы внезапно обнаружили ссылку на несуществующую страницу? Часто при написании новых статей мы вставляем в них ссылки на другие статьи, которые ещё предстоит написать. Это помогает нам отслеживать предстоящий объём работ, хотя иногда мы некоторые из таких статей "откладываем до лучших времён" или даже по рассеянности "теряем". Если Вы нашли ссылку на несуществующую страницу, не стесняйтесь это исправить! Щелчок по такой ссылке приведёт Вас прямо в редактор контента.
    Создать подстраницу
    В правом верхнем углу каждой статьи есть выпадающее меню "Данная страница", в котором есть опция "Новая подстраница". Щелчок по этой опции откроет редактор контента новой дочерней для текущей страницы. После ввода названия и slug можете приступать к написанию контента подстраницы.
    Клонировать страницу
    Создать копию текущей страницы можно с помощью опции "Клонировать текущую страницу" в выпадающем меню "Данная страница" (родительской страницей клона будет родительская страница текущей страницы), при щелчке на которую откроется редактор контента клона. Обычно, это удобный способ "подсмотреть" и "содрать" существующее форматирование.
    Создать ссылку на несуществующую страницу, затем щёлкнуть по ней
    Гибридный способ. Поскольку на каждую страницу должна ссылаться какая-либо другая страница, Вы можете начать с создания ссылки на несуществующую страницу в текущей статье, затем, после сохранения изменений в текущей статье, щёлкнуть по такой ссылке для написания новой статьи.

    Примечание: если Вы не залогинены, то после щелчка по ссылке на несуществующую статью вместо открытия редактора контента получите ошибку 404.

    Рецензирование контента

    После написания новой статьи или редактирования существующей автор может указать, что статья нуждается в рецензировании (review). Это значит, что кто-то должен просмотреть статью на предмет её корректности. Существует три основных вида рецензирования:

    Техническое рецензирование
    Этот вид рецензирования используется в тех случаях, когда требуется, чтобы кто-либо, обладающий основательными знаниями в данной предметной технической области, вычитал статью на предмет её корректности с технической точки зрения. Рецензенты обычно делают пометки и отсылают их автору(авторам) либо правят статью "на лету" (что предпочтительнее).
    Редакторское рецензирование
    Требуется для вычитки и исправления орфографических и грамматических ошибок в тексте, опечаток, а также коррекции форматирования при необходимости. Данный вид рецензирования гарантирует соответствие статьи MDN style guide.
    Рецензирование шаблона
    MDN использует макросы (иногда называемые также "шаблонами") для автоматической генерации контента. Шаблоны представляют собой запускаемые на серверной стороне JavaScript программы, которые содержат некоторые дополнительные расширения, всё это вместе взятое мы называем KumaScript. Пользователи с правами на продвинутое редактирование макросов могут запросить у коллег "рецензирование шаблона" как дополнительную проверку своей работы.

    Статьи, заявленные на рецензирование, имеют один или оба из нижеуказанных баннеров в своей верхней части:

    Screen shot: Review banners

    Ваша задача (если Вы решились стать рецензентом) заключается в вычитке статьи и коррекции возможных ошибок в ней. Очевидно, что Вы должны осуществлять техническое рецензирование только тех статей, в тематике которых являетесь истинным гуру с технической точки зрения. Аналогично, для редакторского рецензирования Вы должны в совершенстве владеть языком, на котором написана рецензируемая статья.

    Поиск статей для рецензирования

    Хотя никто и ничто, конечно, не запрещает искать статьи для рецензирования методом "научного тыка" по всему MDN, есть надёжный способ получить списки статей, выставленных на рецензирование:

    Быстрое рецензирование

    Если Вы прочли статью и не нашли в ней ничего "криминального", Вам не нужно открывать редактор, чтобы пометить статью, как успешно прошедшую рецензирование. Достаточно воспользоваться  "quick review" чекбоксами внизу страницы:

    Screen shot: Quick review box

    Просто чекните соответствующий Вашему типу рецензии чекбокс и подтвердите щелчком на кнопке "Confirm reviews" (если Вы не были при этом залогинены в MDN, система предложит Вам это сделать), после чего у статьи должным образом изменится статус.

    Рецензирование в редакторе

    С другой стороны, если в процессе рецензирования статьи Вам пришлось кое-что в ней подправить, Вы так или иначе уже находитесь в редакторе:

    Screen shot: In-editor review box

    В этом случае Вам нужно снять галочки с чекбоксов, соответствующих типу успешно осуществлённой Вами рецензии, а затем сохранить статью обычным образом.

    Добавить пример кода

    Поскольку основным предназначением данного веб-сайта является предоставление технической документации для разработчиков, примеры кода являются нашей важнейшей заботой. Добавление нового примера кода или улучшение существующего - отличный способ помочь нашим читателям и фантастическая возможность приложения Ваших навыков, если Вы скорее программист, чем писатель!

    MDN поддерживает "живые" примеры кода (live code samples); в примерах используются HTML, CSS и/или JavaScript, встраиваемые в контент статьи и выполняющиеся в "песочницах" <iframe>, что позволяет читателю выполнить работающий пример кода в реальном времени прямо на странице документации без необходимости перехода на какую-либо другую веб-страницу.

    Детали см. в "Using the live sample system".

    Метки документа и участники

    Contributors to this page: Nick_Pershin
    Обновлялась последний раз: Nick_Pershin,