В очередной раз ухитрились написать отчет по тестированию, в котором ни много ни мало 80 страниц. Нет, не так. ЦЕЛЫХ ВОСЕМЬДЕСЯТ СТРАНИЦ. Нет не так. В нем вот сколько страниц (обозначены диезами) : # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #. И на каждой что-то написано, а на многих и нарисовано. Предположив, что читатель потратит по минуте на каждую, получаем почти полтора часа чтения. Предположив 10 читателей отчета, получаем дофига.
Справедливости ради отмечу, что отчет о (а) сравнительном тестировании, (б) тестирование повторное. Оба этих фактора неизбежно увеличивают объем, но тем не менее. Отчет получился непомерной длины. Отмечу также, что решение первого уровня абстракции (сделать кегль и иллюстрации меньше) не проканает – да, страниц станет меньше, но, поскольку количество сведений в отчете останется неизменным, читать станет не быстрее.
Причина появления столь длинного отчета – стандарт ISO/IEC 25062:2006 «Common Industry Format (CIF) for usability test reports». Мы ему добровольно следуем (в такие дни, как сегодня, зачем-то добровольно следуем).
Стандарт, на самом деле, штука хорошая. Можно не думать, что именно надо написать, незачем бояться, что чего-то важное пропущено или тем более забыто. К сожалению, CIF фиксирует не только содержание отчета, но и порядок изложения. Например, описание условий эксперимента, согласно CIF, должно находиться почти в самом начале отчета. В результате невозможно сложить важное, т.е. выводы и результаты, в одно место (начало отчета), а все основания для этих выводов и служебную информацию – в другое (конец отчета). Реально значимые сведения перемешаны с маловажными, что серьезно затрудняет прочтение. Причём чем длиннее получившийся отчет, тем получается хуже, потому что одно только лишь листание на перекрестных ссылках становится как минимум утомительным.
В такой ситуации есть несколько возможных выходов:
- Вовсе плюнуть на CIF и сделать собственный шаблон. Минус – некошерно, пацаны будут смеяться.
- Оставить содержание из CIF, но сделать свой порядок изложения. Минус – кошерно, но пацаны всё равно будут смеяться, потому что получится не CIF (во всяком случае мы потеряем право говорить, что у нас CIF-совместимые отчеты).
- Делать два отчета на проект – один читабельный, другой стандартный. Минус – без соответствующих средств это очень долго и дорого (объем работы, уходящей на сам отчет, возрастет вдвое).
Теоретически, третий вариант таки может быть состоятелен. Например, в Adobe FrameMaker есть хорошо работающий функционал условного текста (conditional text), позволяющий в одном документе иметь несколько частично совпадающих версий одного и то же содержания. Но мы, к сожалению, вынуждены готовить отчеты в MS Word (заказчики требуют), а в нём ничего подобного нет.
Соответственно, спрашиваю широкие народные массы – как бы вы решили проблему чересчур длинных отчетов? Отказаться от CIF? Отказаться от упоминания CIF, но сохранить его суть? Или же воспользоваться трудным путём?
27 октября 2009 в 16:32
Или я чего-то не понимаю, или делать два отчёта на проект не имеет смысла. Ведь если вы отдадите заказчику «читабельный», то поулчится, что у вас всё равно не CIF-совместимые отчёты. Или вы будете вручать 2 версии со словами «вот этот по стандарту, а этот легче читается»?
А какой высший смысл в CIF-совместимости? Она кому-то приносит какую-нибудь ощутимую пользу?
27 октября 2009 в 16:40
Я за второй вариант. Следование не букве, но духу стандарта. В общем-то, читатель отчета от того, что он соответствует CIF, ничего не выиграет.
27 октября 2009 в 16:53
Сергей Педан: “Или вы будете вручать 2 версии со словами «вот этот по стандарту, а этот легче читается»?” - ну да )
27 октября 2009 в 18:33
Ставить метки в самых “вкусных” (предположительно для Заказчика) местах. В начале документа помимо стандартного оглавления, перечислять эти метки.
Сама лично жду, когда же при создании документов/отчетов можно будет использовать теги. Кликнул - вся лишняя информация скрылась.
Еще один вариант - писать по стандарту, но легким языком. Но для таких выпендрежей нужен талант и время
28 октября 2009 в 00:24
Похожую проблему мы решали с помощью DITA (http://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture) — системы документирования, которая вращается вокруг отдельных «топиков», из которых по определенным автором правилам строится финальный документ.
По ссылке интересно, в частности, про conditional text: «Conditional text allows filtering or styling content based on attributes for audience, platform, product, and other properties.» То есть, можно из одних и тех же текстов генерировать CIF-совместимую документацию, чтобы пацаны уважали, и версию полегче, для заказчика, в которой ненужных топиков не будет, а нужные будут расположены в угодном душе порядке.
Другое дело, что внедрение DITA может того не стоить
Это все-таки для IBM-образных корпораций придумывалось.
28 октября 2009 в 01:20
Сейчас я в составе команды делаю проект для одного крупного заказчика. Не буду его называть, скажу лишь, что вы каждый день видите его рекламу по телевизору и на улице и с большой долей вероятности являетесь его клиентами. В результате проекта приходится знакомиться с их документацией и стандартами, читать их тз, а также общаться с их специалистами (хорошими людьми и специалистами своего дела).
И вот что я понял. Что я не хочу работать в такой крупной компании. И дело тут не в размере, а в том, что она неизбежно формалистична, документация и все остальное построено по строгим стандартам и правилам, а четкое разделение труда приводит к тому, что сотрудник компетентен только в узком круге вопросов.
Я не против стандартизации и разделения труда. Но беда в том, что все это приводит к… УБОГИМ продуктам, бездушным и сделанным без любви.
А теперь отвечу на ваш вопрос. Если единственная выгода от следования вашему стандарту - чтобы пацаны не засмеяли - в топку этот стандарт. И пацанов в топку!
28 октября 2009 в 16:31
100% Поддерживаю Алекса: “Если единственная выгода от следования вашему стандарту - чтобы пацаны не засмеяли - в топку этот стандарт. И пацанов в топку!”
28 октября 2009 в 19:09
если стандарт дурацкий, то, вероятно разрабатываются нынче какието новые? имеет смысл посмотреть их сырые скелеты, да делать поближе к ним.
30 октября 2009 в 00:21
Влад, используйте этот ход в комм. предложениях. Напишите: “Мы можем составлять документацию по стандарту CIF, если вам это важно. Но мы с удовольствием бы оградили вас от лишних мучений, связанных с чтением такого вида документации.” Думаю, заказчики увидят в этом глубинные порывы людей, делающих дружественные интерфейсы
5 ноября 2009 в 20:23
Я бы не сказал, что следование CIF - это только пузомерка для своих пацанов. Читать такие отчеты объективно приятнее. Впрочем, даже в Ворде ваши отчеты лучше, чем у известных конкурентов.
Короче, я за CIF и 80 страниц осилил без проблем.