Вики: На что обратить внимание при редактировании

Вики: На что обратить внимание при редактировании

Эта статья является переводом статьи Wiki: Technical Editing.

Содержание:


Это список того, что Вы можете сделать прямо сейчас, чтобы начать вносить свой вклад в TechNet Wiki.

Список проверок для каждой TechNet Wiki статьи

Добавьте, пожалуйста, к тем проверкам, которые Вы обычно делаете, с тем, чтобы мы все могли работать вместе над улучшением Wiki.

1. Тэги

В Wiki тысячи разных тегов. Вот список для проверки на наиболее важные и часто используемые:

  • has Toc, если имеется "Содержание" 
  • has Code, если есть программный код 
  • has Image , если есть изображения 
  • has Comment, если имеются комментарии 
  • For Review, если Вы хотите, чтобы это было перепроверено в последующем           
  • has See Also, если есть секция "Смотри также:"  (то, к чему мы все стремимся)
  • Candidate for deletion, если статья должна быть удалена (спам, пиратство, дубликат, плагиат, устарела,...) (See WiKi: How to Report a TechNet Wiki page)
Вы можете найти другие общие тэги в этой статье Wiki: Common Tags.


2. Содержание

  • В заголовке статьи использован "Title case" (то есть не все буквы заглавные)
  • Правописание 
  • Заполнена секция "Смотри также:"
  • Понятное форматирование в виде параграфов и заголовков 
  • Избегайте использования сокращений, которые могут быть уместны в сообщениях форума, но не в статьях, например: IMHO, AFAIK, BTW
  • Для технических терминов - сокращений постарайтесь дать соответствующую ссылку. Помните, что у статьи могут быть читатели, не знакомые с предметом статьи и нуждающиеся в объяснении
  • Используйте литературный язык, избегайте просторечий и слэнга

3. Внешний вид

  • Добавьте маркер "Содержание" ([TOC]), когда это необходимо (статья имеет достаточный размер и структурирована по содержанию)
  • Добавьте секцию "Смотри также"
  • Используйте символы соответствующего регистра (НЕ ВСЕ ЗАГЛАВНЫЕ) для:
    • Заголовков 
    • Заголовков HTML
    • Ссылок  
  • Используйте шрифты, цвета и раскладки по умолчанию, если это возможно.

4. HTML

  • Проверьте HTML ссылки (like nested or deformed header tags)  и другие битые/неиспользуемые HTML
  • Проверьте секцию кода - лучше использовать кнопку Code block для соответствующего языка
  • Проверьте правильность RGB color names (not values), которые используются - для опытных редакторов
  • Убедитесь, что заголовок <a name=> не включает "0" (ноль). Если заголовок включает число "0",  тогда заголовок не появится в TOC. Всего лишь уберите нули из <a name=> script. Например, измените "<a name=SQL_Server_2008></a>" на "<a name=SQL_Server_8></a>".  Для статей на русском языке надо изменить текст в ссылках <a name =..> на английский. Смотрите об этом подробнее в статье Вики: Как добавить оглавление в статью на русском языке
  • Если Вы увидели, что у  таблицы обрезаны колонки с правой стороны, попытайтесь исправить это добавлением следующего тэга <div style='overflow:scroll'>table here</div> (спасибо Tord Glad Nordahl за этот приём)

 

5. Улучшения

       
  • Любое дополнительное содержание, которое развивает статью
  • Ссылки на другие статьи, особенно в секции  See Also 
  • Комментарии к статье -  поощрение, поздравления, вопросы, критика


Смотри также


Другие языки

Английский оригинал этой статьи упомянут в блоге WiKi Ninja Wiki Life: Technical Editing
Сортировать по: Дата публикации | Последние | Самый полезный
Комментарии
  • This article is supposed to be a translation of the article mentioned to be a quick guide of editing (not long article). If you can help with the translation, please do so, otherwise leave this article as is.

  • Параграфы 2 и 3 практически копируют друг друга, может быть объединить их?

  • Исходная статья рекомендует Title case  в заголовке, то есть наподобие "How to Configure Software Distribution". Но в Ru так как раз не принято, исключая заимствования. Мы делаем так, как в  примере "плохо", напр. "Скрытие пользовательского набора дисков в проводнике Windows". Ограничится требованием - не все буквы заглавные или обсудить отдельно?

    Предлагаю также изменить название статьи на "На что обратить внимание при редактировании".

  • I agree with all your points and thanks a lot for doing wonderful translation of the article! I agree with the title change, can you please adjust? Sorry for not answering earlier, I do not receive e-mail notifications right now. BTW, "ssylok" in the beginning is wrong, it means "tags" (Many tags, these are most common)

  • I think we can suggest to not use all upper case and may be say that in English articles we want proper casing, but not in Russian articles.

  • Что характерно для руссоязычной Вики (впрочем, как и для любой другой), на качество и количество контента наплевать. Зато как "правильно делать SEO" и "как побольше сделать бессмысленных редактирований для активностей" — через край.

    Это к тому, что "как" написано — вторично. Главное, "что" написано. А годность информации от навешивания рюш мало меняется.

Страница 1 из 1 (элементов: 6)