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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Очень нужны ваши советы, Как объединить пользовательскую документацию с тестерской
 
Добрый день, коллеги!
Ситуация такая. Есть руководство пользователя, созданное в Help&Manual.
Достаточно объемное, больше 100 подразделов. У этого руководства 5 версий для разной группы пользователей, у которых, соответственно, отображается немного различный функционал. Веду их все отдельно.
Шеф поставил задачу помимо РП вести внутреннюю документацию для тестировщиков, которая включает все то, что не вошло в РП (хинты, сообщения во всплывающих окнах, тех.требования и прочее).
Сейчас это выглядит так: есть статья, в ней есть ссылка на страницу руководства, тестировщику приходится читать и то и то одновременно, что не очень удобно, он хочет, чтобы текст шел последовательно.

Что в данном случае можно сделать?
Перегружать само руководство дополнительной информацией нехорошо.
Вести одновременно несколько видов документации трудозатратно.
Может есть какие-то особенности для Help&Manual, которые можно использовать?
Я пробовала вставлять переключатели со скрытым текстом, но они видны при экспорте, пользователи будут спрашивать, что это за плюсики.
Очень жду ваших советов  help-smile
 
почему нельзя просто сделать custom build в проекте, например for_testers? и помечать им все текстовые фрагменты, которые предназначены только для тестировщиков
 
Разобралась, как это делается, спасибо!!! :idea:
Изменено: Laya - 13.05.2016 14:27:18
 
Цитата
Laya написал:
Разобралась, как это делается, спасибо!!!
Не могли бы описать алгоритм действий ?
 
Laya , можете подсказать как решили?  
 
 
Цитата
Buzoter написал:
Цитата
 Laya  написал:
Разобралась, как это делается, спасибо!!!
Не могли бы описать алгоритм действий
Извините, переехала в другой город и совсем забыла про форум.
Нужно выделить скрытый текст и нажать кнопку IF, в открывшемся окне выбрать то, что выбрано на картинке.



Что получилось:

 

Затем опубликовать документ, выбрав при публикации аналогичное название сборки. Документ будет опубликован без скрытого текста (для пользователей). Для полного текста (для тестеров) отмечать сборку не нужно.

Изменено: Laya - 06.12.2017 11:57:45
 
Цитата
writer написал:
Laya  , можете подсказать как решили?  
Никак не решили. Тестеры сказали, что им нужны статьи технического характера для пошагового тестирования, в результате я теперь занимаюсь и тем, и другим (и пользовательской документацией, и внутренней).  
Изменено: Laya - 06.12.2017 12:26:08
 
Laya спасибо, что отписались!

Извините, переехала в другой город и совсем забыла про форум.

С переездом! Вы уж нас не забывайте!
 
Братья по разуму, подскажите, какой уровень з/п ориентировочно должен быть у техписа, который:
- создает пользовательскую и админскую документацию в различных форматах, инструкции и пр.;
- является контент-менеджером сайта компании (заносит новости, обновления, правит баннеры);
- создает презентации по работе в системе;
- ведет внутреннюю документацию технического характера?

На русском языке. Нормоконтроля нет. Работа - удаленно.
Изменено: Laya - 06.12.2017 17:01:55
Страницы: 1
Читают тему