Документация - наша профессия

«У вас в голове могут рождаться распрекрасные идеи, но, если вы не умеете довести их до сознания слушателей, вы ничего не добьетесь».

Я эмигрировала в США много лет назад и сейчас живу в городе Форт-Уорт, штат Техас. Для меня как для эмигранта коммуникация имеет самое важное значение во всех ее аспектах. Иммигрировавшие во взрослом возрасте люди часто испытывают проблемы с самоидентификацией, если не могут корректно выразить свои мысли. Именно стремление к способности самовыражения побудило меня к поиску эффективных способов коммуникации. Я изучила основные понятия и модели эффективной коммуникации для того, чтобы исключить недопонимание со стороны собеседника, и таким образом научилась излагать свои мысли просто и понятно.

Ольга Маркус

9 Сентябрь 2013

Работа в команде Docco – тщательно продуманный и взвешенный для меня выбор. Довольно продолжительное время я наблюдала за работой команды со стороны – и все это время развитие компании и ее подход к делу не переставали меня восхищать и вдохновлять. Мое уважение вызывает и европейская точность, и крайне ответственное отношение к каждому проекту, и продуманность всех процессов – все это верные признаки того, что участники команды действительно любят свою работу.

Главе компании удалось собрать вокруг себя профессионалов, которые с неподдельным интересом и энтузиазмом берутся за новые проекты, готовы делиться опытом с коллегами, открывать для себя новые сферы профессиональной деятельности. Мобильность и гибкость – одна из основополагающих черт команды Docco. Каждый ее участник – личность, специалист в своем деле, будь то аналитика, техническое документирование или экспертиза, при этом каждый готов вникать в самую суть доверенного ему проекта, взаимодействовать с другими его участниками, брать на себя ответственность – то есть быть настоящим членом команды.

Атмосфера взаимного уважения, профессионального доверия и уверенность в коллегах, стремление к постоянному развитию, возможность работы надо новыми для себя направлениями – ключевые для меня причины выбора Docco в качестве места работы. Команда сама собой вдохновляет меня на активную работу и саморазвитие, я могу и делиться своим опытом, и узнавать много нового от своих коллег.

К счастью, высокий профессионализм команды Docco по достоинству оценивают не только сотрудники и партнеры, но и клиенты, число которых растет с каждым годом.

Анна Пономарева

Работа должна приносить удовольствие.

В сферу информационных технологий я попала не сразу. Будучи по образованию переводчиком, занималась переводами и подготовкой документации по юридической тематике. В один прекрасный момент я поняла, что хочу сменить направление деятельности. Выбор пал на сферу ИТ. Это было словно озарение свыше, ведь для меня – лингвиста – данная область представлялась чем-то чрезвычайно загадочным, очень интересным, но недостижимым.

Таким образом, я переквалифицировалась в технического писателя. Уже несколько лет работаю в этой специальности и не жалею о принятом решении. Больше всего в профессии мне нравится возможность разнообразить свою деятельность, расширить свои технические познания и реализовать желание работы с текстами. Технический писатель – это такая специализация, в которой возможен рост, как личностный, так и профессиональный, в которой постоянное развитие и улучшение уже существующих навыков является обязательным условием.

Ирина Мигачева

Отрасль информационных технологий является одной из наиболее динамично развивающихся отраслей в мире. Современные информационные технологии с их стремительно растущим потенциалом и быстро снижающимися издержками открывают огромные возможности для новых форм организации труда и занятости в рамках, как организаций, так и общества в целом. Моя деятельность в этой сфере началась еще в 2005 году одновременно с получением второго высшего образования, связанного именно с ИТ. С того момента были попытки сменить сферу, но все же ИТ оказалась самой интересной и привлекательной.

Предложение работать в Команде Docco я приняла с большой радостью и оптимизмом. Здесь я занимаюсь с удовольствием тем делом, которое приносит удовлетворение, сопровождается хорошими взаимоотношениями с коллегами, дает возможность совершенствоваться и расти как личность. Помимо этого деятельность в Команде позволяет вносить в работу творческий вклад, что для меня немаловажно.

Лилия Молдыбаева

Работать в сфере информационных технологий я начала еще в институте. Успела попробовать себя в роли тестировщика, технического писателя и бизнес-аналитика. Сейчас основной сферой моей деятельности является руководство проектами разработки и внедрения программного обеспечения.

В Docco я участвую в проектах связанных с проектированием систем, бизнес-анализом и написанием технической документации. Рассчитываю на интересные и разноплановые проекты.

Себе и коллегам я бы хотела пожелать развития как индивидуального, так и всей команды в целом.

Елизавета Казначеева

Работа в команде Docco открыла для меня широкие возможности для получения новых знаний и опыта.

Множество интересных проектов, увлеченность своей работой и настоящий командный дух – вот те факторы, которые помогают мне профессионально расти и совершенствоваться. Я получаю удовольствие от того, что имею возможность относиться к моим задачам творчески, так как креативное мышление, а порой и нестандартные решения – залог успеха нашей команды.

Татьяна Лукичева

Среди технических писателей бывают "технические" и "писатели". Я принадлежу к писателям. У меня всегда была склонность к гуманитарным наукам, поэтому я и выбрала факультет иностранных языков, который закончила в 1999 году.

Техническим писателем я стала не сразу, долго работала референтом-переводчиком, и на протяжении всего своего трудового пути занималась письменным переводом.

Попав на работу в IT-компанию, я поняла, что мне очень интересна эта область. Это и причастность к компьютерному миру, и общение с совершенно особенными людьми. Сначала мне казалось, что гуманитариям в эту сферу путь закрыт, но позже я узнала, что в отделах технического документирования немало филологов. Конечно, мне захотелось присоединиться.

Наталья Серегина

Говорят, что технический писатель –– это интеллектуальный кентавр, лучший гуманитарий среди технарей и лучший технарь среди гуманитариев. На мой взгляд, очень емко и точно. Хотя бы потому, что помимо знаний в области «софта» и «железа» никак не обойтись без умения говорить с разработчиками на их языке, а еще понимать и предвосхищать потребности конечного пользователя, для которого пишется документация.

Наталья Кривенко

Для меня знакомство с Командой Docco началось с череды случайных событий и одной встречи, переросшей в дружбу. Продолжительное время я и Docco много слышали друг о друге, но наши профессиональные пути не пересекались.

Приглашение на участие в проекте от команды Docco я приняла, не задумываясь и не смотря на работу в достойной IT-компании и участие в интересных проектах.

Природная любознательность, стремление к развитию и получению нового опыта, да и просто неумение сидеть на месте, не позволили мне засомневаться в принятом решении.

Алена Кочубей

Мое участие в проектах команды Docco началось практически с начала ее существования, в 2005 году. Тогда моя карьера как специалиста в сфере информационных технологий и технического документирования только начиналась. Кто бы мог подумать, что именно здесь я смогу получить огромный багаж знаний, что именно здесь я найду людей близких мне по духу, интересам и профессии.

Работа в команде для меня очень важна, ведь именно здесь я получаю личный профессиональный рост, обмен опытом, общение с коллегами за чашечкой чая или кофе, что тоже не маловажно для сплоченного коллектива. Каждый человек уникален по своей сути и именно эта уникальность каждого из моих коллег дозволяет в нашей команде взаимодополнять друг друга. Каждый несет ответственность за свою часть поставленной задачи, что влияет на общий результат и позволяет нам доверять друг другу.

Екатерина Зорина

Пожалуй, начну с предыстории моего появления в команде. Имея интересную работу в сфере информационных технологий и профессионально развиваясь, я пришла к мысли о том, что пора дальше постигать новые пути при профессиональном движении вперед. Внутренняя уверенность и стремление к самореализации, появление в нужном месте в нужный момент, наверное, и определили мой приход в команду. Теперь я очень четко чувствую и понимаю, что наша команда — это настоящий сплоченный профессиональный коллектив, объединенный общим делом, командным духом и успешными результатами.

Елена Горлова

В августе 2010 года мне поступило предложение присоединиться к команде Docco, которое я с радостью приняла. И сразу же окунулась в мир слаженной работы и профессионализма.

Присоединение к жизни команды Docco стало важным этапом в моей профессиональной деятельности: работа с многогранными людьми, знатоками своего дела, участие в разнообразных и интересных проектах. Дружеская атмосфера в команде, слаженность работы, готовность к взаимовыручке настраивают на полную отдачу в работе.

Евгения Григорьева

Если ты любишь свою работу, то она обязательно ответит взаимностью. В моей истории техническая коммуникация стала любимым делом, поскольку она смогла удовлетворить одновременно мою тягу к общению (с заказчиком / пользователем / разработчиком / коллегой) и к современным технологиям. 14 лет практики от технического писателя и junior-аналитика до автора команды утвердили меня в мысли, что умение писать — призвание.

Ваше сообщение отправлено!

Ваше сообщение не отправлено!

Как люди используют документацию, и как эффективнее ее писать

Есть нескольк хорошо известных факторов, влияющих на эффективность документации как средства обучения и как руководства по выполнению работы.

Подход к документации, известный как минимализм, проверен годами, но остается не очень известным за пределами узкого круга заинтересованных специалистов. Этот метод позволяет создавать безупречную документацию, которую легко читать. Весьма вероятно, что руководства и инструкции, созданные с применением этого подхода, будут полезны, а значит, будут использоваться.

Почему люди пользуются документацией?

Люди используют разные инструменты в соответствии с необходимостью достичь определенной цели. Использование документации — это почти всегда очень активный процесс. Люди обращаются к документации, когда им нужно что-то сделать прямо сейчас. Сбор информации, приобретение знаний и понимание механизмов выполнения процессов для многих читателей являются второстепенными вопросами.

Когда люди ищут в документации конкретную инструкцию «Как делать» и не могут ее найти, вряд ли они будут читать связанные с ней объяснения. Поэтому документация должна удовлетворять первостепенные потребности пользователя, иначе возможности удовлетворить второстепенные уже не будет.

У многих читателей ожидания от документации невысоки. Каждый раз, когда им сложно получить информацию из руководства или иного документа, это лишний раз убеждает их в том, что документация не отвечает их потребностям.

Документация должна выполнять две функции:

• Процедурную, объясняющую как это сделать;
• Описательную, объясняющую, почему то или иное действие выполняется именно так.

Эти две функции являются взаимоисключающими, и поэтому материалы следует разделять, чтобы читатель мог получить именно ту информацию, которая ему нужна.

Как люди читают документацию?

Первое, что нужно понять: люди часто обращаются к документации в последнюю очередь. Это связано с убежденностью читателя в следующем:

• В документации нет ничего нового, что стоило бы знать;
• Есть более быстрые способы получить информацию;
• Лучше спросить того, кто знает.

Документацию читают, чтобы выполнить какую-либо задачу, и у читателя есть определенные ожидания. Было доказано, что люди пытаются объединить в одно целое изучаемое и уже известное, и этот процесс замедляет чтение. Дети не имеют такого укоренившегося опыта, как взрослые, и поэтому пассивно принимают систему и следуют инструкциям, как есть. Такая разница в подходе привела к убеждению, что если вам нужно решить вопрос, привлеките к этому ребенка.

Когда люди читают документацию и пытаются научиться чему-либо, они рассуждают в процессе работы и закрепляют полученные соображения в первоначальном знании. Таким образом, люди читают документацию и руководства так же, как изучают систему — исследуя.

Как люди ищут информацию в документах?

Исследование показывает, что только в 25 % случаев для поиска информации использовались соответствующие индексы и оглавления. Однако в 90 % случаев люди предпочитают бегло просматривать страницы в поисках информации.

Это частично объясняет, почему онлайн-документация и справки вызывают у пользователей такие сложности.

Проблемы с документацией

Руководства часто содержат обширные объяснения с узкоспециализированными примерами и практическими заданиями. Такая структура не отвечает потребности читателя в первостепенной информации. Если читатель строго следует документации, то устранение несущественных ошибок в работе программы может отнять у него много времени. Большинство документов не затрагивает вопрос устранения незначительных ошибок, а это важно для начинающего пользователя, так как часто читатель не понимает, какие его действия привели к ошибке. Руководства пользователя часто содержат слишком много материала, в котором сложно найти требуемую информацию.

Минимализм в документации

Идея минимализма состоит в том, чтобы предоставить пользователю документацию, которая:

• повторы;
• информацию, не относящуюся к конкретной задаче.

• краткое изложение;
• описание;
• практические примеры.

Поскольку люди в целом и новички в частности не читают всю документацию, возможно, лучше пощадить их и описывать только важные характеристики и особенности.

Как писать минималистичную документацию

Смысл состоит в том, чтобы создавать простую в использовании документацию, которая понятна новичкам и может быть справочным пособием для более продвинутых пользователей.

Заголовки

Наименования заголовков должны быть ориентированы на задачу, а содержание должно являться просто указателем. Содержание должно быть сгруппировано так, чтобы было понятно новичку.

Удалите повторы

Заголовки и примечания должны быть справа для нечетных страниц и слева для четных страниц. Это позволит пользователю пролистывать документ и видеть все необходимые заголовки. Определенные действия следует объяснять один раз и далее давать на них ссылку.