Лучший инструмент для создания руководств пользователя

Мы планируем создать руководство пользователя только для внутреннего пользования. Это 150-страничный документ в Word для самостоятельно разработанного программного инструмента. Руководство пользователя требует постоянного обновления. Перевод не нужен. Мы хотели бы иметь - простой в использовании интерфейс для инструмента - простоту обновления - хорошую функциональность по управлению историей изменений, лучше, чтобы история изменений была детализирована для каждой функции программного обеспечения.

У вас есть рекомендации по инструменту?

Я немного не понимаю, что вы здесь ищете. Нужны ли вам рекомендации по интерфейсу программного средства или рекомендации по программному обеспечению для обновления руководства пользователя программного средства? Если второе, что плохого в том, чтобы просто использовать Word для создания PDF-файлов? Или вы хотите руководство пользователя внутри программного обеспечения? (Если первое, то, боюсь, вы ошиблись сайтом.)
Привет Нил, я ищу инструмент для создания руководства пользователя для инструмента. Поскольку это инструмент собственной разработки, он постоянно обновляется. Нам необходимо отразить эти изменения в руководстве пользователя. Word будет сложно вести учет всех изменений. Например, инженер выдает тикет на изменение ПО, нам нужно внести это обновление в руководство пользователя и записать, кто сделал изменение, когда и по какой причине это изменение (т.е. связано с каким тикетом). Я думаю о каком-то инструменте, который поддерживает модульную запись и функцию для записи истории изменений по модулям. Я делаю это яснее? Спасибо
Привет, @xifeng, у тебя есть SharePoint?
Да. У нас есть SharePoint.

Ответы (3)

Для внутренней документации я нашел вики весьма полезными. В вики есть несколько полезных функций для этой задачи:

  • встроенное отслеживание изменений
  • документ может быть структурирован как несколько страниц (например, по одной на основной раздел) для облегчения управления; затем отдельные страницы можно редактировать без необходимости объединения изменений в основной документ.
  • некоторые (большинство?) вики-платформ обнаруживают надвигающиеся конфликты редактирования; если у кого-то еще есть страница, открытая для редактирования, вы узнаете (чтобы потом не было грязных слияний)
  • может быть доступен любому, у кого есть браузер, на любом устройстве (попробуйте прочитать документ Word или PDF на своем телефоне...)
  • если ваша вики содержит страницу «последние изменения», работа видна и, следовательно, с большей вероятностью получит дополнительные полезные правки или комментарии (больше сотрудничества)

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

Абсолютно - это сразу пришло мне в голову. Просто следите за тем, чтобы поддерживать удобное и актуальное оглавление/указатель, так как они не создаются автоматически (или то, что создается автоматически, далеко не дружественно), и вики будет отличным инструментом. Особенно, если вики предназначена для внутреннего использования, разрешайте редактирование пользователями. Они часто дают хорошие советы по шаблонам использования, о которых разработчики даже не думали, а страницы обсуждения избавляют внутреннюю службу поддержки от многих головных болей, поскольку пользователи могут направлять друг друга.
О да, вам определенно нужно оглавление, иначе оно просто превратится в ящик для цифрового мусора. :-)
Что касается печати: на некоторых вики-платформах есть опция «Экспорт в PDF», которая подходит для этого.
@MartinMcCallion звучит удобно! Вы случайно не знаете какие? Это только для каждой страницы или некоторые берут иерархию страниц и объединяют ее в один PDF-файл?
В работе мы используем Confluence от Atlassian. Однако это не бесплатно, за исключением, возможно, ограниченной версии. И я думаю , вы можете заставить его сделать что-то вроде PDF «этой страницы и всех под ней». Но я не совсем уверен в этом.

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

Будут ли работать GoogleDocs ? Мы широко использовали их на моем предыдущем рабочем месте (в университете), так как у всех была учетная запись Google, которая была учетной записью электронной почты кампуса, и у нее было хорошее отслеживание версий.

Как и в случае любого общего документа, обычно вам нужен кто-то ответственный, который будет заботиться о том, чтобы части не обновлялись, а они должны обновляться, и следить за актуальностью ToC/index.

Увы, на моем нынешнем рабочем месте использование Gmail и GDocs запрещено. В целом инноваций также не много, поэтому у нас нет постоянно обновляемых многопользовательских документов (по крайней мере, в отделах, с которыми я взаимодействовал).

Лучший инструмент для создания руководств пользователя
СпросиСетьПолитика конфиденциальности1y, 0v