Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Какие требования к оформлению help - справок?
 
Есть ли определенные требования к оформлению справок помощи? От чего отталкиваться и чем руководствоваться в этом?
 
Лично я не слышал о каких-либо общепринятых стандартах на электронную справку. ИМХо, тут всё ограничивается техническими возможностями инструментария, с помощью которого делается справка, и фантазией автора.

Единственное, от чего необходимо предостеречь - это закачивание в справку html-простыней или ненарезанной по подразделам печатной документации в PDF.
 
Цитата
Единственное, от чего необходимо предостеречь - это закачивание в справку html-простыней .
Это насколько я поняла длинные фрагменты текста? ?
Цитата
по подразделам печатной документации в PDF.
Впервые слышу, что в справку вставляется фрагмент PDF :shock:
 
Цитата
Цитата
Единственное, от чего необходимо предостеречь - это закачивание в справку html-простыней .
Это насколько я поняла длинные фрагменты текста? ?:

Да.

Цитата

Цитата
по подразделам печатной документации в PDF.
Впервые слышу, что в справку вставляется фрагмент PDF :shock:

Я не это имел в виду. Это когда берут печатную документацию в исходном формате и пытаются из неё делать электронную справку, нарезая топики из глав, а не самых маленьких подразделов документов. Получается аналог html-простыни.
Такое по неопытности могут затребовать начальники-программисты и прочий люд, мало понимающий технологии производства документации.
 
Цитата


Я не это имел в виду. Это когда берут печатную документацию в исходном формате и пытаются из неё делать электронную справку, нарезая топики из глав.
Вот это да! :shock: Надо сделать на форуме Доску Позора для такой документации :D .
 
Цитата
Цитата


Я не это имел в виду. Это когда берут печатную документацию в исходном формате и пытаются из неё делать электронную справку, нарезая топики из глав.
Вот это да! :shock: Надо сделать на форуме Доску Позора для такой документации :D .
Она есть, зайдите в Акулы пера. :)
Хочу все знать!
 
Вот такого я еще не слышал, что режут PDF))
 
Цитата
Вот такого я еще не слышал, что режут PDF))

[color=blue:3a4hgtz5]О сколько нам открытий чудных
Готовят просвещенья дух
И опыт, сын ошибок трудных,
И гений, парадоксов друг,
И случай, бог изобретатель... [/color:3a4hgtz5]
А. С. Пушкин
 
Очень часто делают наоборот. Из онлайн документации делают принт версию например PDF. При условии, что вы пользуетесь достаточно гибким редактором, можно достичь неплохих результатов.
А тут пишу Я - http://fortechwriters.com/
 
Цитата
Очень часто делают наоборот. Из онлайн документации делают принт версию например PDF. При условии, что вы пользуетесь достаточно гибким редактором, можно достичь неплохих результатов.
Ну только когда это надо? Можно же просто сконвертить документ или в справку или в pdf
Работаю по-старинке...
 
Ну у нас, например, основная версия-это все таки онлайн хелп. Но некоторым клиентам привычней видеть документацию в PDF или Word. Вот и создаем PDF из онлайн хелпа.
А тут пишу Я - http://fortechwriters.com/
Страницы: 1
Ответить
Читают тему
Форма ответов
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить