Как лучше написать руководства пользователей?

Добрый день.

Существует фирма, которая производит физические устройства и ПО к ним.
Необходимо написать руководство пользователя для каждого из продуктов, а также техническую спецификацию устройств.
Подскажите, где можно почитать про написание и составление такой документации? Какое ПО лучше использовать (потому что получается достаточное больше кол-во документов и без контроля версий/удобной структуры разобраться будет невозможно)?
  • Вопрос задан
  • 291 просмотр
Решения вопроса 1
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
ferdi

1. Если прямо отвечать на поставленный вопрос, то при множестве устройств, модификаций устройств и ПО, версионности и т.п. вам, скорее всего, подходит технология единого источника. Что это такое, почему она нужна и другие аспекты - см. тут: https://vimeo.com/240324661

2. Если подходить более правильно к вопросу, то вам сначала надо задаться целью. Что вы хотите получить от документации?

Тогда начинаем отсюда: Как лучше сделать документацию компании? и постепенно строим картину у себя в голове.
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы