vadi7
@vadi7
Студент, любитель *nix

Какие общепринятые принципы формирования электронных документов вам известны?

Есть небольшое по функциям и объему, но довольно специфичное ПО, используемое в нескольких частных организациях. В силу специфичности и роста оъема функция простого ReadMe в *.txt файле стало маловато, напрашивается небольшой User Manual со скриншотами и пояснениями.
Пробовали прикладывать *.doc с необходимой информацией, но из кодеров неважные дизанеры/верстальщики/писатели - документ выглядит люто и шибко креативно, особенно некоторые моменты вроде вставки и различного форматирования/выравнивания/эффектов изображений.
Если ли какой-нибудь мануал по базовым принципам создания именно User Manual'ов? :)

Заранее благодарен.
  • Вопрос задан
  • 234 просмотра
Решения вопроса 1
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
довольно специфичное ПО, используемое в нескольких частных организациях


Не указаны:
1. Предназначение ПО.
2. Тип ПО.
3. Требования по документации к ПО со стороны организации-клиента.

Начините с ответов на эти вопросы. Потом будет ясно, какие советы давать.
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
AlexZaharow
@AlexZaharow
Программист. Javascript, Java!
В принципе может быть рано отказываться от формата .txt. Гляньте вот эту штуку www.zim-wiki.org/downloads.html

Вот пример моей документации экспортированной из Zim в виде сайта:


9fa0768b304f4fddab241cbe97ff2228.png


В самом zim просто вставка теста и картинок без особых наворотов (хотя есть куча плагинов). Похож на OneNote от MS, только умеет экспортировать в большое количество форматов. (OneNote вообще не даёт эскпортировать видимо в маркетинговых целях).
Ответ написан
Ваш ответ на вопрос

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

Войти через TM ID
Похожие вопросы