Паскаль Берингер, основатель проекта Hyphen, делится своим рецептом создания эффективной структуры пользовательской документации в Dr.Explain.
— Пожалуйста, расскажите нам о себе и своем проекте.
— Hyphen (hyphen.press) — это десктопное издательское приложение для Windows.
Я самозанятый разработчик из Ирландии, и родом из мира допечатной подготовки. Работаю разработчиком уже 30 лет. Я хотел создать инструмент для профессионального создания книг, журналов, брошюр рекламы за небольшую стоимость и с низким порогом вхождения.
— Почему вы заботитесь о создании справочной документации для своего программного обеспечения? Как вы делали это в прошлом?
— Hyphen — это огромное приложение с богатой функциональностью. Мне очень нужно объяснить его работу пользователям. Сначала я использовал Sandcastle, затем GhostDoc. Оба не очень эффективны.
Я попробовал другие инструменты, но и они оказались для меня неактуальными.
— Как вы начали использовать программное обеспечение Dr.Explain?
— После тестирования нескольких приложений для создания руководства пользователя, которые оказались сложными и трудоемкими, я наткнулся на Dr.Explain.
И вот оно, чудо — за три дня я написал основное содержание руководства и добавил большинство скриншотов. Затем я добавил несколько пояснений, ссылки на свои видео примеры и внутренние ссылки. Это было просто!
— Какова структура вашей текущей документации?
— Сначала мы думали, что будем использовать только онлайн-видео. Но быстро выяснилось, что этого недостаточно. Поэтому я решил вернуться к классическому онлайн-руководству пользователя, с видеороликами для объяснения более сложных концепций.
Моим клиентам нравится руководство со скриншотами, пояснительными текстами и видео.