From BlenderWiki
Другие страницы посвященные редактированию Wiki:
Список задач | Процесс редактуры | Руководство редактора | Руководство по стилю оформления | Заметки для переводчиков
После того, как Blender.Org объявляет первый Release Candidate (RC1) для новой версии, должен начинаться процесс обновления Руководства пользователя. Целью этого процесса является всестороннее обновление всего Руководства пользователя (Manual/xxx) для всех обновлений существующих функций, новых возможностей и усовершенствований, изменений в пользовательском интерфейсе, что будет в новой версии, для всех Языков.
[edit] Процесс
В первую очередь необходимо создать " страницу Wiki Tasks/ManualVXX" (см. #Шаблон_для_Wiki_Tasks.2FManualVXX), где VXX номер версии, например 243 для версии Blender 2.43. Содержание этой страницы должно быть отредактированной копией текущего Оглавления для каждого языка, начиная с английского. Исправления включают заголовки 1-го уровня для каждого языка, с сохранением отступов для удобства чтения, где в начале каждой строки помещен
- to doнужно-ли обновить?
шаблон, удалены любые разрывы столбцов и форматирование, удалены ссылки на уроки, и добавление любых новых функций, которые будут отображаться в Оглавлении. Редактор/автор должен ознакомиться с Замечаниями к версии в качестве отправной точки для построения списка новых тем в Оглавлении.
Далее, каждый автор, заинтересованный в содействии новому релизу, должен проверить руководство, сравнить его с новой функциональностью, и определить, действительно ли тот или иной раздел нуждается в обновлении. На странице замечаний к версии должны быть комментарии относительно того, какие разделы нуждаются в обновлении, и в какой степени, и позволят автору добровольно взять на себя задачу, с некоторой степенью координации, с тем, что мы не отрывали друг другу на пальцы ног.
| Дословный перевод рулит. Прим. пер. |
Для всех частей руководства не затронутых новой версией, автор/редактор должен в строке назначить
- on holdбез изменений? имяавтора
шаблон статуса готовности, указывающий, что они не думают, что необходимо что-либо менять. Редактору или независимому автору/участнику, заинтересованному в этом разделе необходимо убедиться, что он не затронут, и, если да, назначить
- doneимяавтора имяредактора (без изменений)
статус этой теме.
Когда автор допускает обновление раздела, он изменяет To Do статус
- in progressимяавтора
25%
где имяавтора его вики имя входа в систему. ДОБРОВОЛЬЧЕСТВО ДРУГИХ АВТОРОВ ЗАПРЕЩЕНО. По мере продвижения, автор должен обновлять число процентов прогресса соответственно. В зависимости от заданного числа, progressbar будет меняться с шагом в 25%: так 0%, 25%, 50%, 75%, 100%. Числа ниже нуля и более 100 все равно дадут 0.
Когда автор достигает 100% готовности, независимому редактору необходимо проверить проделанную работу на предмет аккуратности, речи от 1-го лица, полноты, не технического языка, и т.д. Любые необходимые значительные исправления должны быть переданы обратно посредством страницы обсуждения автора, чтобы тот довел дело до завершения. Малые изменения должны быть сделаны на месте, и, если страница достаточно хороша,
- doneимяавтора, имяредактора (итого)
присваивается статус, где итого является очень кратким (40 символов) резюме, что было сделано, или просто ссылкой на раздел текущих замечаний к версии, который обусловил обновления.
Таким образом, когда обновление в процессе, очень легко увидеть, кто над чем работает и как далеко продвинулось обновление проекта. После завершения доступен полный список изменений, из которого видно, кто пожертвовал свое время и энергию, чтобы сделать руководство лучшим, насколько это возможно.
[edit] Шаблоны
Полезные шаблоны, что я нашел до сих пор (см. также User:JesterKing#Mediawiki_projects)
- {{WikiTask/Todo|пункт}} дает
- to doпункт
- {{WikiTask/Onhold|неопределенный проект}} дает
- on holdнеопределенный проект
- {{WikiTask/Done|хороший проект}} дает
- doneхорошие проекты
- {{WikiTask/Inprogress|0|собираюсь Todo этой странице ...}} дает
- in progressсобираюсь Todo этой странице ...
0%
- {{WikiTask/Inprogress|10|только начал, сделано 10%}} дает
- in progressтолько начал, сделано 10% 10%
- {{WikiTask/Inprogress|30|хороший прогресс, 30%}} дает
- in progressхороший прогресс, 30%
30%
- {{WikiTask/Inprogress|65|идет хорошо, 65%}} дает
- in progressидет хорошо, 65%
65%
- {{WikiTask/Inprogress|90|практически завершено, 90%!}} дает
- in progressпрактически завершено или даже готово! 90%!
90%
[edit] Изображения
Устаревшие изображения должны быть заменены новыми. Пожалуйста, прочтите Template:Updateimage о том, как это должно быть сделано.
Если вы наткнулись на изображение, которое вы не можете заменить по каким-либо причинам, пожалуйста, по крайней мере пометьте его с помощью шаблона {{updateimage}}.
Список изображений, отмеченных таким образом находится здесь: Category:Update image
[edit] Полнота
Как вы узнаете, когда обновление раздела завершено, и что нужно проверить и сделать, чтобы обновить раздел руководства пользователя? Вот ваш Контрольный список:
- Скачать и установить RC1. Не предполагайте, что что-то работает так или иначе, а на деле используйте его, с тем чтобы дать информацию для пользователей из первых рук
- Зарегистрироваться, для участия в ревизии разделов, изменяя статус и добавляя ваше имяавтора на странице ManualVXX. Таким образом, вам не придется беспокоиться о том, что кто-то другой перебьет вашу ревизию, и вы впустую потратите свое время.
- Прочитать Замечания к версии, касающиеся вашего раздела.
- Убедиться в существующей функциональности, иными словами, убедиться, что ваша тема по-прежнему работает так, как раньше. Посмотреть на изменения в пользовательском интерфейсе; поля могут передвигаться в пределах панелей, например. Все функции, которые уже находятся в руководстве или справочнике (для 2,43 это в основном различные новые узлы) все равно должны быть проверены по отношению к окончательному релизу, так как некоторые вещи изменились несомненно (например, некоторые узлы изменили пользовательский интерфейс ...) .
- Изучить и проверить новые возможности. Создать практический пример, и сделать скриншоты. Рассуждайте так: "почему я должен хотеть использовать эту новую возможность?"
- Набросать черновое описание новой функции, в песочнице, если оно значительно, или прямо в вики-странице, в противном случае. Используйте шаблон {{working}}, если вносите изменения в вики. Ваш текст должен быть положительным, точным, давать содержательные примеры и практические советы о том, как использовать эту функцию, чтобы получить результат. Использовать светлый юмор, картинки, и речь от первого лица. Первое предложение каждого пункта, как и многие другие предложения должны начинаться с "Вы ..." или "Ваш", выраженных явно или подразумеваемых, подобно данному параграфу.
- Вместо того чтобы начинать с нуля, вы можете просто Wiki-фицировать содержимое Changelogs & связанных страниц.
- Обновить номера версий в вики-заголовках
- Обновить (или добавить) скриншоты если это необходимо (где-то было хорошее руководство о том, как должны выглядеть скриншоты .. например тема по умолчанию и т.д... дайте ссылку кто-нибудь?)
- Привлечь вашего знакомого (в качестве добровольца), чтобы дать обзор вашей работе.
Первым шагом при обновлении вики для новой версии будет всегда посетить Замечания к версии (в данном случае Release Notes/Notes243). Все новые возможности, которые перечислены там (как и содержание обоих, Замечаний к версии и changelog представлены на blender.org) должны быть перенесены.
Не ПРЕДПОЛАГАЙТЕ, что читатель знает даже незначительный функционал или магическим образом будет самостоятельно проверять сочетания клавиш, чтобы увидеть, какие из них работают. Программисты любят поэкспериментировать, но пользователи, как правило, боятся, что они могут что-либо сломать и не решаются даже на простые действия. Таким образом, необходимо объяснить все функциональные возможности, а не только некоторые из них.
[edit] Отчеты о ходе работ
Цель нашего сообщества иметь обновленное руководство пользователя в течение месяца после выхода новой версии. Следующие страницы были созданы с помощью вышеупомянутого процесса:
[edit] Шаблон для Wiki Tasks/ManualVXX
Текущие Языки определяются шаблоном Languages. Когда создаете список дел по разделам Руководства, скопируйте и вставьте содержание этой страницы для создания заголовков для страницы нового релиза. Затем скопируйте и вставите Оглавление для каждого языка, где это уместно. Изменить Оглавление, как описано выше (добавление To-Do шаблона статуса) для создания первоначального состояния дел и списка регистрации.
![[]](/skins/blender/open.png)
