Набираем инструментарий
Ниже я поведаю о том, как я боролся за удобство редактирования.
Начинается самое интересное. У меня была задача сделать так, чтобы нашим коллегам ХОТЕЛОСЬ пользоваться нашим инструментом. Для этого нужно, чтобы простые и повседневные действия не требовали изучения, а делались привычным способом. Дальнейшее изучение инструментария (язык разметки, всякие расширения) должно приносить немедленную и ощутимую пользу повышать скорость работы или предоставлять новые возможности.
Удобство собственно редактирования
Совместная работа. Встроенных средств разрешения конфликтов достаточно. При том что редактируя документ не целиком, а конкретный раздел, шансы на создание такого конфликта очень малы. У нас это случается не чаще раза в неделю.
История изменений. Встроенных средств вполне достаточно.
Поиск. Сейчас используется родной поиск MediaWiki. (В интернете есть куча способов, как прикрутить тот или иной продвинутый поисковый движок. Но пока хватает и родного, для того чтобы по одному-двум ключевым словам найти нужную статью.)
На головной странице каждого проекта есть ссылки на все (или почти все) статьи по этому проекту. Это такая большая-большая страница, состоящая только из ссылок. Они разбиты по категориям (описание процессов, интерфейс пользователя, межсерверное взаимодействие и т.п.). Там даже есть ссылки на те спецификации, которых еще нет, но которые точно должны быть.
Навигация / ссылки. На боковой панели (sidebar), а также на первой странице вики есть ссылки на все наши проекты, а на главной странице еще и на описание наших внутренних процессов.
Найти нужную статью в нашей вики можно двумя способами:
Удобство поиска.
С этим все просто. Всё, что необходимо, для того, чтобы прочесть спецификацию это браузер. Навыки работы в браузере наверное есть у всех :)
Удобство чтения.
Вспоминаем требования к инструментам
На меня очень заинтересовал доклад из Яндекса . Еще более интересной и познавательной оказалась дальнейшая беседа и ответы на вопросы в уголке экспертов на уютном диванчике. Это стало тем толчком, который склонил чашу весов от долгих раздумий к активным действиям.
Что из этого вышло читайте ниже.
Продолжаю разговор об инструментах, с помощью которых можно сделать такой сложный и непривычный процесс написания спецификаций простым, доступным и даже прикольным (см. ). Я уже давно подумывал о том, чтобы приспособить для этого вики.
Пишем спецификации. Часть 2. Инструменты. Вики всё под рукой
26 февраля 2010 в 00:16
Пишем спецификации. Часть 2. Инструменты. Вики всё под рукой / Хабрахабр
Комментариев нет:
Отправить комментарий