Викиучебник:Как писать учебники и руководства

Материал из Викиучебника — открытых книг для открытого мира
Перейти к: навигация, поиск

Вам не нравится Викиучебник? Вы просто не умеете его готовить!

Мистер Чемберс! Эта книга — «Готов ли человек?» — это… это кулинарная книга!


Принести пользу Викиучебнику по силам любому желающему. Здесь мы рассмотрим, как именно это можно сделать, — а заодно и как извлечь пользу из участия в проекте.

Два направления работы[править]

Как и в других проектах Фонда Викимедиа, участие в Викиучебнике представлено двумя основными направлениями:

  • «тематическим» — созданием новых учебников, дополнением существующих новым материалом (включая ссылки на авторитетные источники и иллюстрации), исправлением фактических ошибок;
  • «организационным» — выявлением и устранением существующих проблем в оформлении (и, в меньшей степени, — содержании) учебных материалов, поддержкой «вспомогательных» страниц, участием в обсуждениях, выполнением административных действий, etc.

Тем не менее, первичная цель в обоих случаях остается неизменной — сделать материалы проекта более ценными для читателей и создателей производных работ, а также сделать использование этих материалов и участие в работе над ними более удобным для тех, кому это может быть интересно.

Участники, разумеется, могут преследовать собственные цели. В случае «тематического» направления, такой целью может быть получение критики на собственную работу, или же просто обеспечение к ней доступа всех заинтересованных лиц. Материалы, важные для профессиональной деятельности, конечно, можно опубликовать на «сетевых ресурсах» предприятия, но сколь прост будет к ним доступ «извне»? Напротив, материалы Викиучебника доступны едва ли не из любой точки мира и едва ли не с любого «сетевого» устройства.

«Организационное» направление, по-видимому, будет наиболее интересным участникам-читателям, поскольку позволяет сделать поиск и чтение материалов более удобным, а также может привлечь к проекту новых авторов и, следовательно, — новый материал.

Создание нового учебника[править]

Для создания нового учебника по конкретной теме крайне желательно наличие некоторого опыта в объяснении этой самой темы, — не важно, в «формальной обстановке» или «неформальной». Полезным будет и наличие уже готового, представленного какой-либо аудитории материала (ориентировочно — 1000 слов и более.)

Новый учебник, или?[править]

Перед внесением материала в проект следует проверить наличие близких по теме учебников или разделов — возможно, материал будет более уместен как новый раздел уже существующего учебника? Одновременно с этим можно будет выяснить названия подходящих для нового учебника тематических категорий.

Удостоверьтесь также, что предлагаемый материал соответствует основным принципам именно данного проекта. Размещаемый здесь материал должен отвечать на вопрос «как?». В некоторых случаях, материал может подойти другим проектам Фонда:

  • Википедии — если материал отвечает на вопрос «что такое?»;
  • Викиверситету — подойдут любого рода материалы, полезные в учебном процессе: учебные курсы и методические указания, работы учащихся и требования к их оформлению, списки экзаменационных вопросов и списки литературы для подготовки, etc.;
  • Викитеке — опубликованные («в печати») свободные работы — в том числе учебники и руководства, а также их переводы — не исключая и выполненные самими участниками Викитеки;
  • Викицитатнику — сборники цитат (по авторству, теме, произведению);
  • Викигиду — путеводители по городам и странам;
  • Викисловарю — словарные статьи;
  • Викиновостям — новости.

Обратите внимание, что критерием освоения некоторых дисциплин (в частности, в сфере истории, филологии, философии) является знакомство с первоисточниками и критическими материалами по теме. Учебником по таким дисциплинам может оказаться, например, собрание сочинений Шекспира (на правах первоисточника) или сборник статей Википедии (как изложение идей, содержащихся в критике.) Уместность материалов такого рода в Викиучебнике является предметом споров. По-видимому, первоисточники (в том числе аннотированные) следует в первую очередь предлагать Викитеке; обзор критики — Википедии; «практические задания» — Викиверситету. Викиучебник может служить разве что «инкубатором» для таких материалов.

Выбор названия[править]

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

Так, название Ядро Linux будет уместно лишь для учебника, в котором рассмотрена сборка данного ядра, в деталях разобрано его внутреннее устройство, приведены примеры написания новых компонент и публикации разного рода изменений в рассылках разработчиков, использования команднострочных средств — а равно и файловых систем /proc и /sys — для настройки и извлечения разнообразной информации, etc.

Обратите внимание, что создание учебника автоматически резервирует одноименную категорию для его страниц. Как следствие, создание учебника с названием, например, Бокрский язык сделает невозможным создание с таким названием тематической категории. Поэтому, для новых учебников следует, по-возможности, использовать более развернутые названия (например: Разговорник бокрского языка.)

Если возникают сомнения относительно названия нового учебника или уместности нового материала в существующем учебнике, можно разместить материал в «личном пространстве» и запросить мнение сообщества, — например, на общем форуме.

Одностраничный учебник[править]

Готовые материалы небольшого объема (в пределах порядка 2000‒5000 слов) допустимо размещать «одной страницей». Для этого (предполагая использование «типового» пользовательского агента Всемирной паутины) можно воспользоваться следующим рецептом.

  1. Введите желаемое название учебника в поле ввода на странице Служебная:Поиск. Если учебника с таким названием не существует — будет предложено создать новую страницу. С той же целью можно просто перейти по ссылке вида https://ru.wikibooks.org/wiki/Название нового учебника.

  2. Разместите материал на странице согласно следующему образцу.

    В данном учебнике мы рассмотрим… (краткое — в пределах 150 слов — описание предмета учебника, принятого автором подхода к изложению, etc.)
    
    == Название раздела ==
    
    Текст раздела.
    
    == См. также ==
    * Ссылки на другие учебники, страницы Википедии, прочие материалы по теме.
    
    == Примечания ==
    {{Примечания}}
    
    {{Темы |Одна тема|Другая тема}}
    {{Готовность |50%}}
    
  3. Используйте функцию предварительного просмотра для проверки корректности оформления нового материала. После внесения материала его желательно повторно просмотреть и устранить обнаруженные дефекты.

Многостраничный учебник[править]

Для материалов (предполагаемого) объема порядка 2000 слов и более следует создавать многостраничные учебники, для чего подойдет следующий рецепт.

  1. Введите желаемое название учебника в поле ввода на странице Служебная:Поиск. Если учебника с таким названием не существует — будет предложено создать новую страницу. С той же целью можно просто перейти по ссылке вида https://ru.wikibooks.org/wiki/Название нового учебника.

  2. Создайте «главную страницу» учебника согласно следующему образцу.

    В данном учебнике мы рассмотрим… (краткое — в пределах 150 слов — описание предмета учебника, принятого автором подхода к изложению, etc.)
    
    == Содержание ==
    
    ; Название одной главы
    : [[/Название раздела/]]{{Стадия кор |25%|2017-11-24}}
    : [[/Название раздела/]]{{Стадия кор |75%|2017-11-24}}
    ; Название другой главы
    : [[/Название раздела/]]{{Стадия кор |50%|2017-11-24}}
    
    == См. также ==
    * Ссылки на другие учебники, страницы Википедии, прочие материалы по теме.
    
    {{Темы |Одна тема|Другая тема}}
    {{BookCat}}
    {{Готовность |25%}}
    

    Если количество разделов — невелико, на главы материал можно не делить. С другой стороны, если материал достаточно дифференцирован, можно использовать двухуровневую систему наименования страниц учебника — Название учебника/Главы́/Раздела.

  3. Используйте функцию предварительного просмотра для проверки корректности оформления страницы.

  4. Благодаря шаблону {{BookCat}}, при просмотре страницы будет доступна ссылка на (пока несуществующую) категорию страниц учебника. При ее создании, за основу можно взять следующий образец.

    {{Заголовок категории учебника}}
    
    [[Категория:Одна тема]]
    [[Категория:Другая тема]]
    
  5. Воспользуйтесь ссылкой на какой-либо из несуществующих разделов учебника для его создания. Оформить страницу раздела можно соответственно данному выше образцу оформления одностраничного учебника, обязательно используя, однако, шаблон {{BookCat}} вместо {{Темы}} и {{Готовность}}. «Аннотация» в начале страницы, разумеется, также должна относится к материалу данной отдельной страницы, а не учебника в целом.

  6. После создания (дополнения) раздела — проверьте актуальность шаблона {{Стадия кор}} в «Содержании» на «главной странице» учебника.

Перенос материала из других проектов[править]

Содержание других проектов Фонда также доступно (как правило) на условиях принятой в Викиучебнике лицензии CC BY-SA 3.0 (или же на условиях еще менее строгих CC BY или CC0), что позволяет сравнительно свободно заимствовать такой материал в данном проекте.

Следует помнить, однако, что лицензии Creative Commons требуют сохранения информации об авторстве материала. Для чего, в свою очередь, следует «взять на вооружение» следующие простые правила:

  1. всегда указывать источник заимствования; желательно — в кратком описании соответствующего изменения (например: Перенесено из [[w:42 (число)]].); если этого по какой-либо причине не было сделано, допустимо указать источник на «странице обсуждения»;
  2. если переносимый материал подлежит удалению из истории исходного проекта (как, например, при удалении из проекта исходной страницы в целом), для сохранения авторства необходимо перенести полную историю изменений исходной страницы; сделать это может любой администратор по запросу участника на странице Викиучебник:Запросы к администраторам.

Эти же правила применимы и при переносе материала между страницами Викиучебника, а равно и при заимствовании доступных на условиях CC BY-SA 3.0 (или менее строгих CC BY, CC0, etc.) материалов любых других ресурсов Всемирной паутины; в последнем случае — с той лишь оговоркой, что необходимая информация об источнике и авторстве может оказаться слишком подробной для краткого описания. При этом, такую информацию необходимо привести на «странице обсуждения».

Наконец, для заимствования материалов, условия распространения которых неизвестны или несовместимы с CC BY-SA 3.0, необходимо получить разрешение правообладателя по форме OTRS.

Степень готовности[править]

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

Определять степень готовности можно по-разному. Следующие соображения, однако, представляются применимыми в наиболее общем случае:

  1. степень готовности должна прямо следовать из соответствия фактически представленного материала — заявленному в «аннотации»; предполагается, что оценить степень такого соответствия может любой знакомый с предметом участник проекта;
  2. по-видимому, степень готовности учебника в целом не должна превышать степени готовности любого из основных разделов;
  3. решение о том, какие разделы считать «основными», принимается опять-таки на основании их соответствия «аннотации» к учебнику; в спорных случаях — решение остается за сообществом редакторов конкретного учебника.

Организационная деятельность[править]

Любая «организационная деятельность» начинается с обсуждений. Тем участникам, которым она интересна, следует обратить внимание на следующие страницы.

Следующие страницы также существуют в проекте, однако по различным причинам фактически не используются.

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

Разумеется, чтобы успешно применять и улучшать правила и руководства проекта, следует для начала их изучить, для чего будет полезно обратиться к странице Викиучебник:Список правил и руководств и категории Категория:Викиучебник:Правила и руководства.

Отметим отдельно, что хотя опыт участия в других проектах Фонда может оказаться полезным и в Викиучебнике, отдельные правила, а равно и практика их применения, могут существенно отличаться. Так, например, правило «не инструкция» Википедии к Викиучебнику применимо лишь с обратным знаком.

Категоризация[править]

См. также: Викиучебник:Категоризация, Викиучебник:Шаблоны.

Для отнесения страниц основного пространства к тематическим и служебным категориям используется ряд шаблонов, включая упомянутые выше {{Темы}}, {{Готовность}} и {{BookCat}}.

Викиучебник постоянно развивается и накопленным материалам может стать «тесно» в рамках единой темы. В таком случае, может быть полезно выделить часть из них в новую тему — для создания которой применим нижеследующий рецепт. Этот же рецепт будет полезен и в случае, когда для конкретной темы не создано категории всех учебников или страницы в пространстве Полка:. (Что, отметим, весьма вероятно — коль скоро используемые на таких страницах шаблоны существуют в проекте лишь с декабря 2014 г.)

  1. Воспользуйтесь поиском, включив в него в том числе пространство имен Категория: — не исключено, что подходящая или достаточно близкая тема уже существует.

  2. Создайте новую страницу с именем вида Категория:Название темы по следующему образцу.

    Описание темы, со ссылкой на одноименную страницу в пространстве имен Полка:'''[[Полка:Название темы |текст ссылки]]'''.
    
    [[Категория:Первая родительская тема]]
    [[Категория:Вторая родительская тема]]
    
    Ссылки на данную категорию в других языковых разделах — если существуют.
    

    Здесь же можно применить и шаблон {{Нав}} — в случае, если аналогичные категории существуют и в других проектах Фонда Викимедиа.

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

  3. Создайте также страницу категории всех учебников для данной темы — Категория:Название темы/все учебники — следующего содержания:

    {{Категория всех}}<noinclude>
    <!-- Пожалуйста добавляйте ссылки на другие языковые разделы ниже.  Спасибо. -->
    
    </noinclude>
    
  4. Наконец, создайте для данной темы страницу в пространстве Полка:Полка:Название темы, взяв за основу следующий образец.

    {{Страница темы
      | родитель  = Первая родительская тема
      | родитель2 = Вторая родительская тема
      | описание  = Описание темы, со ссылкой на подходящую статью Википедии — '''[[w:Статья |текст ссылки]]'''.
      }}<noinclude>
    <!-- Пожалуйста добавляйте категории и ссылки на другие языковые разделы ниже.  Спасибо. -->
    
    </noinclude>
    
  5. На всех этапах выше полезно использовать функцию предварительного просмотра для проверки корректности оформления создаваемых страниц.

Административные обсуждения[править]

Помочь решению «административных» вопросов может любой опытный участник — потратив собственное время и силы на оформление так называемого «предварительного итога» по конкретному обсуждению, а также, возможно, — устранив проблему или проблемы, явившиеся основанием для исходного запроса. Никаких особых «технических привилегий» («флагов») для этого не требуется.

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

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

С другой стороны, комментарии (пожелания, предложения) по использованной в «итоге» формулировке следует оставлять на «странице обсуждения» подводящего итог администратора.

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

Участникам, которым удается создавать новые запросы на выполнение административных действий чаще, чем администраторам удается подводить итоги по таким запросам, имеет смысл оформить заявку на получение привилегий администратора.

См. также[править]