Обсуждение:Main Page
Не буду трогать онлайн-документацию, выскажу своё мнение как техписателя по тому, что я увидел в pdf. PDF-документация сделана любительски, без соблюдения мало-мальски принятых в ней норм даже для софтовой доки: нормального оглавления, кроссылок, списков, нумерации иллюстраций.
На месте руководства я бы поднял зарплату техпису и нашёл бы другого на его место, либо гнал бы в шею текущего. Потому то, что лежит у вас на сайте - это вариант графоманства.
З.Ы. Ничего личного.
Да, мы знаем, что текущий вариант документации не дотягивает до совершенства. При ограниченных ресурсах, выбирая между совершенствованием платформы и настроек, с одной стороны, и развитием документации -- с другой, мы уделяем основное время первому.
Такое отношение к документации характерно для многих компаний, особенно тех, которые ориентированы на внутренний рынок и вынуждены экономить. Другое дело, что написание мало-мальски прилично выглядящей документации не требует каких-то значительных ресурсов компании и дорогостоящих специалистов. Разве что у вас секретарша её пишет или программисты по 1-2 часа в день, проклиная это занятие. И ладно была бы она для внутренних потребностей компании, но для публичного коммерческого продукта такое состояние руководства пользователя - просто позор. Стиль текста, навевает мысли о том, что человек, писавший его, не закончил даже вуза - не писал дипломную работу и вообще не представляет, как пишется научный или технический текст. ИМХО, конечно.
Разные главы документации писали разные люди. Проблема с документацией в том, что те, кто хорошо знают Гедымин, не имеют времени для написания документации, а технические авторы не владеют или Гедымином или предметными областями для написания хорошей документации. Если Вы можете предложить свои услуги, мы будем очень рады.
Спасибо за предложение, но, к сожалению, я гражданин Украины, а фрилансерством пока не занимаюсь, набираюсь опыта. По поводу знания системы могу сказать следующее: в других софтовых конторах думают абсолютно также, что техписы не знают системы, не знают предметной области и т.д. и т.п. Техпис и не должен знать эту предметную область, как аналитик: ему важно уметь быстро переключаться с одной системы на дугую, с одного документа на другой. Так, я раньше документировал систему электронного банкинга. Теперь уволился из той компании и документирую систему, аналогичную вашей. За две недели написал с нуля два средних по величине документа - по 50 стр. Это при том, что не знаю системы в целом, а пробежался по парочке модулей.
Другое дело, что документацию должны почитывать тестировщики - это да. Вот при грамотном техписе и чтении документации внутри конторы она становится нормальной, а не слабым звеном.
Если у Вас так неплохо получается, то все-таки подумайте над нашим предложением. Может получится поработать совместно.
