Где я могу найти хороший шаблон для руководства пользователя программного приложения?
Ищу ссылки на ресурсы, которые помогут мне написать руководство пользователя для программного приложения. Я стремлюсь к тому, чтобы помочь мне структурировать руководство, придать ему соответствующий стиль письма и убедиться, что оно отлично выглядит и ощущается повсюду.
2 ответа
Эта ссылка имеет несколько сильных сторон. Каждый пункт представлен с четкой речью и с встроенными обоснованиями.
При написании процедур используйте активный голос (например, нажмите здесь) и обращайтесь к пользователям напрямую (напишите "вы", а не "пользователь").
При объяснении действия используйте форму "команда" глагола:
Msgstr "Выберите опцию в меню и нажмите [ENTER]."
http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml
Вот полный список тем, затронутых в вышеупомянутой статье:
- Главная страница (титульные страницы)
- Обложка и титульный лист
- отказ
- Предисловие
- содержание
- Тело гида
- процедуры
- Написание процедур
- Фрагмент текста
- Пронумеруйте свои шаги
- Использование подхода if-then
- Справочные материалы
- Назад вопрос
- глоссарий
- Индекс
- Установление стандартов
- Формат документа
- Стиль структуры
- Технический язык
- Обращение к пользователю
- Представляя свой материал
- Специальные требования
Для структурирования и внешнего вида подумайте об использовании фреймворка, такого как DocBook.
DocBook использует схему разметки XML, которая заставляет вас задуматься о том, как должен быть организован ваш документ. Существуют XSL-преобразования, которые преобразуют его в распространенные форматы, такие как HTML и PDF, с целым набором параметров конфигурации, чтобы заставить его выглядеть так, как вы хотите. И это с открытым исходным кодом (бесплатно). Конечно, есть и недостатки: схема довольно большая, и редактирование может быть сложной задачей без хорошего редактора XML.