From 841aae260382e2bf5ebb44d765d8c7301d27caab Mon Sep 17 00:00:00 2001
From: Alexey Istomin MDN имеет систему «живых примеров», где пример кода, показанный на странице, служит для отображения вывода этого же примера. Однако во многих существующих статьях есть примеры кода, которые еще не используют эту систему, и их необходимо преобразовать. MDN имеет систему «живых примеров», где пример кода, показанный на странице, служит для отображения вывода этого же примера. Однако во многих существующих статьях есть примеры кода, которые ещё не используют эту систему, и их необходимо преобразовать. Живые примеры, позволяющие продемонстрировать работу кода, делают документацию более динамичной и наглядной. В этом руководстве описывается, как "оживить" существующие примеры. Время от времени вы можете столкнуться с проблемами при использовании MDN. Будь то проблема с инфраструктурой сайта или ошибка в содержании документации, вы можете либо попытаться исправить ее самостоятельно, либо сообщить о проблеме. В то время как первое предпочтительнее, последнее иногда является лучшим, что вы можете сделать, и это тоже хорошо. Время от времени вы можете столкнуться с проблемами при использовании MDN. Будь то проблема с инфраструктурой сайта или ошибка в содержании документации, вы можете либо попытаться исправить её самостоятельно, либо сообщить о проблеме. В то время как первое предпочтительнее, последнее иногда является лучшим, что вы можете сделать, и это тоже хорошо. Очевидно, поскольку MDN - это вики, лучшее, что вы можете сделать, - это исправить обнаруженные проблемы самостоятельно. Но, возможно, вы не знаете ответа или у вас уже истекает срок выполнения вашего собственного проекта или чего-то в этом роде, и вам нужно описать проблему, чтобы кто-то мог рассмотреть ее позже. Очевидно, поскольку MDN - это вики, лучшее, что вы можете сделать, - это исправить обнаруженные проблемы самостоятельно. Но, возможно, вы не знаете ответа или у вас уже истекает срок выполнения вашего собственного проекта или чего-то в этом роде, и вам нужно описать проблему, чтобы кто-то мог рассмотреть её позже. Способ сообщить о проблеме с документацией – подача заявки. Шаблон проблемы содержит разделы для получения информации, необходимой для начала работы по устранению проблемы. Не стесняйтесь удалять любую часть шаблона, которая не полезна или не имеет отношения к вашей проблеме Конечно, наше писательское сообщество занято, поэтому иногда самый быстрый способ решить проблему с документацией – это исправить ее самостоятельно. Дополнительные сведения см. в разделе создание и редактирование страниц. Конечно, наше писательское сообщество занято, поэтому иногда самый быстрый способ решить проблему с документацией – это исправить её самостоятельно. Дополнительные сведения см. в разделе создание и редактирование страниц. Kuma – платформа, разработанная Mozilla для веб-сайта MDN, находится в состоянии непрерывного развития. Наши разработчики, а также ряд добровольных участников, постоянно вносят улучшения. Если вы видите ошибку, или у вас есть проблема с сайтом, или даже есть предложение по поводу чего-то, что могло бы сделать программу более интересной, вы можете использовать форму заявки Kuma для подачи отчета. Вы также можете использовать эту форму для сообщения о проблемах с производительностью сайта, хотя есть вероятность, что средства мониторинга производительности уже уведомили соответствующих людей. Kuma – платформа, разработанная Mozilla для веб-сайта MDN, находится в состоянии непрерывного развития. Наши разработчики, а также ряд добровольных участников, постоянно вносят улучшения. Если вы видите ошибку, или у вас есть проблема с сайтом, или даже есть предложение по поводу чего-то, что могло бы сделать программу более интересной, вы можете использовать форму заявки Kuma для подачи отчёта. Вы также можете использовать эту форму для сообщения о проблемах с производительностью сайта, хотя есть вероятность, что средства мониторинга производительности уже уведомили соответствующих людей. Ищете темы, которые нуждаются в записи глоссария? Посмотрите список незадокументированных терминов в конце целевой страницы глоссария. Щелкните любую из этих ссылок, чтобы начать новую страницу глоссария для элемента, на который вы нажали; затем выполните нижеуказанные действия. Ищете темы, которые нуждаются в записи глоссария? Посмотрите список незадокументированных терминов в конце целевой страницы глоссария. Щёлкните любую из этих ссылок, чтобы начать новую страницу глоссария для элемента, на который вы нажали; затем выполните нижеуказанные действия. Если же у вас уже есть идея для новой записи в глоссарии, просто нажмите на кнопку "Сделать новую запись в глоссарии" (см. ниже) так, чтобы она открылась в новой вкладке, а затем выполните нижеуказанные действия. Первое, что нужно сделать, это выбрать термин, о котором писать. Если вы не знаете, какие термины нуждаются в определениях, вы можете проверить наш список предложений. Просто нажмите на термин и начните писать. Если вы уже авторизованы в системе, то вы попадете в Редактор MDN. Первое, что нужно сделать, это выбрать термин, о котором писать. Если вы не знаете, какие термины нуждаются в определениях, вы можете проверить наш список предложений. Просто нажмите на термин и начните писать. Если вы уже авторизованы в системе, то вы попадёте в Редактор MDN. Если это необходимо, можете добавить несколько дополнительных абзацев, но будьте осторожны – так можно и увлечься, и вот вы уже пишете огромную статью. Написать полноценную статью – это прекрасно, но, пожалуйста, не помещайте ее в глоссарий. Если вы не уверены, где разместить свою статью, не стесняйтесь обратиться за помощью и обсудить это. Если это необходимо, можете добавить несколько дополнительных абзацев, но будьте осторожны – так можно и увлечься, и вот вы уже пишете огромную статью. Написать полноценную статью – это прекрасно, но, пожалуйста, не помещайте её в глоссарий. Если вы не уверены, где разместить свою статью, не стесняйтесь обратиться за помощью и обсудить это. Вот несколько простых рекомендаций, которые стоит применять при написании записей в глоссарий: Заканчиваться запись в глоссарии всегда должна разделом "Узнать больше". Этот раздел должен содержать ссылки, которые помогут читателю подробнее изучить вопрос: узнать больше деталей, научиться использовать соответствующие технологии и так далее. Мы рекомендуем сортировать ссылки по трем группам: Мы рекомендуем сортировать ссылки по трём группам: Общие знанияОшибки в документации или запросы
-Ошибки сайта или предложения функционала
-Как писать записи
-Шаг 1: Выберите термин, которому хотите дать определение
-Шаг 2: Дайте краткое определение
@@ -45,7 +45,7 @@ translation_of: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary
Как создать хорошую запись глоссария
-
Ссылки, которые предоставляют информацию более общего характера, например, ссылка на Википедию – это хорошая отправная точка.
Узнать больше
- Ссылки на учебные пособия, упражнения, примеры или любые другие материалы, которые помогают читателю научиться использовать технологию, стоящую за определенным термином.
Иногда один и тот же термин может иметь разные значения в зависимости от контекста. Чтобы избежать возможных разночтений и путаницы, следуйте этим рекомендациям: