Сайт «живой документации» требует культуры отношения, иначе люди будут сомневаться, стоит ли им что-то писать, или сочтут, что они могут писать только «одобренные» материалы. Такие компромиссы изначально присущи так называемой модерируемой публикации. Не стоит позволять всем и каждому редактировать инструкции по проверке резервного генератора, но ведь даже компетентный автор может, например, что-то упустить или исказить в первоначальной публикации. В большинстве случаев эту проблему можно решить, предоставляя возможность оставлять комментарии к странице и преобразовывать комментарии в содержимое, когда сам автор или достаточное число других комментаторов посчитают их справедливыми. Если случайно будет сделана ошибка, контроль версий может предоставить доступ к неизмененной версии. Когда непонятно, какая версия является правильной, контроль версий, по крайней мере, может показать список изменений и предоставить какой-то кон-текст, помогающий принять окончательное решение или сформулировать запрос разъяснений по телефону или электронной почте.
Будьте готовы к тому, что вам придется потратить некоторое время на управление системой wiki, пока люди не освоятся с ней и не поднимутся до уровня вашей культуры. Определите, какая степень детализации будет «правильной» для вашей группы, и, как это бывает с любыми документами, прежде чем все станет выглядеть так, как вы считаете нужным, будут иметь место какие-то разногласия между обеими сторонами. В некоторых группах есть системы документации, которые представляют собой просто скопированные электронные письма без особого упорядочивания по темам, в других группах есть страницы с продуманными инструкциями для каждого важного элемента инфраструктуры. Преимущество использования wiki или похожей системы «живой документации» в качестве временной СМ8 состоит в том, что по мере накопления документов вы можете перейти от стихийной системы к более формализованной. С течением времени страницы и записи могут быть реорганизованы и очищены и, возможно, переведены в новые разделы или экспортированы в более формальную СМ8.
Опубликовал Kest
February 03 2012 20:09:25 ·
0 Комментариев ·
3577 Прочтений ·
• Не нашли ответ на свой вопрос? Тогда задайте вопрос в комментариях или на форуме! •
Комментарии
Нет комментариев.
Добавить комментарий
Рейтинги
Рейтинг доступен только для пользователей.
Пожалуйста, залогиньтесь или зарегистрируйтесь для голосования.
Нет данных для оценки.
Гость
Вы не зарегистрированны? Нажмите здесь для регистрации.