Перейти к содержимому

Selenium WebDriver: полное руководство
онлайн, начало 19 октября
Логи как инструмент тестировщика
онлайн, начало 22 октября
Школа для начинающих тестировщиков
онлайн, начало 122 октября
Тестирование REST API
онлайн, начало 22 октября
Фотография

Многопользовательское ведение документации к ПО


  • Авторизуйтесь для ответа в теме
Сообщений в теме: 10

#1 uctepuka

uctepuka

    Новый участник

  • Members
  • Pip
  • 20 сообщений
  • ФИО:Алексеева Анна
  • Город:Москва

Отправлено 12 Сентябрь 2018 - 13:30

Здравствуйте! 

У каждого ПО есть справка помощи и сопроводительная документация, это не секрет. Мы не сделали открытия, всё аналогично. Есть справка помощи на русском языке и других языках, есть руководство по эксплуатации, техническая документация. 
Справка помощи изначально делается в текстовом редакторе и затем переконвертируется в CHM формат. Остальные документы также делаются в текстовом редакторе и сводятся в свой формат (chm, pdf и т.д.).
Некоторые документы являются составными частями других документов как полностью, так и частично.

А теперь вопрос: посоветуйте ПО или принцип работы, чтобы при изменении одного документа, входящего в состав (полностью или частично) другого документа, изменения были и там и там.

Или ещё ситуация: есть документ на русском и английском языках. Вношу изменения в документе на русском, как удобнее работать с этими изменениями в документе на английском языке?

В небезызвестном текстовом редакторе есть функция "сравнения двух версий документа". На одном языке проблем нет, от версии к версии сравнить можно, а вот между двумя языками или документами включающими друг друга такое сравнение некорректно.

Каким ПО пользуетесь вы для создания документации?

Буду рада, если поделитесь опытом работы и советами.


  • 0

#2 BadMF

BadMF

    Специалист

  • Members
  • PipPipPipPipPip
  • 719 сообщений
  • ФИО:Dmitry Petrov

Отправлено 12 Сентябрь 2018 - 13:53

 

 

Справка помощи изначально делается в текстовом редакторе и затем переконвертируется в CHM формат.

 

 

в общем случае это неверное утверждение.

 

Документация делается в специализированном ПО. Есть много как платных так и бесплатных инструментов для этого.


  • 0

#3 Spock

Spock

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 060 сообщений
  • ФИО:Роман

Отправлено 12 Сентябрь 2018 - 14:10

 

 

в общем случае это неверное утверждение.

тут в частном случае имеется ввиду

 

понятно что многие делают доки в конфлюэнсе, но этим тут не помочь видимо


  • 0

#4 Little_CJIOH

Little_CJIOH

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 1 179 сообщений
  • ФИО:Власкин Павел
  • Город:Санкт-Петербург


Отправлено 12 Сентябрь 2018 - 14:20

Это вам техписов надо спрашивать. Ведение документации отдельный и весьма не простой процесс.
Лично я видел процесс в котором документация хранилась в git процессилась так-же как код: тикеты в джире, коммиты, пул-реквесты с ревью, сборка в тимсити.
Как и трекалась ли вообще англоязычная документация - я не знаю.
  • 1

#5 BadMF

BadMF

    Специалист

  • Members
  • PipPipPipPipPip
  • 719 сообщений
  • ФИО:Dmitry Petrov

Отправлено 12 Сентябрь 2018 - 14:42

 

 

 

в общем случае это неверное утверждение.

тут в частном случае имеется ввиду

 

понятно что многие делают доки в конфлюэнсе, но этим тут не помочь видимо

 

нет, я не про конфлюенс, я про настоящую "коробочную" документацию к продукту.

 

Такую документацию делают в серьёзных инструментах, типа Adobe RoboHelp

 

Кстати этот инструмент умеет и git и sharepoint для колоборации =)

 

вообще считается лидером на рынке, но политика лицензирования у Адоба вызывает отващение лично у меня.


  • 1

#6 uctepuka

uctepuka

    Новый участник

  • Members
  • Pip
  • 20 сообщений
  • ФИО:Алексеева Анна
  • Город:Москва

Отправлено 13 Сентябрь 2018 - 07:18

Это вам техписов надо спрашивать. Ведение документации отдельный и весьма не простой процесс.
Лично я видел процесс в котором документация хранилась в git процессилась так-же как код: тикеты в джире, коммиты, пул-реквесты с ревью, сборка в тимсити.
Как и трекалась ли вообще англоязычная документация - я не знаю.

О да, процесс действительно непростой. Техписы рисуют документы в word'e и радуются жизни, ещё и "обижаясь", что в их документах приходится постоянно вносить корректировки из-за изменений в Help'ax. Собственно из-за этого и весь переполох.

 

 

Сейчас стала изучать вопрос, искать удобный продукт. Рассматриваю Dr.Explain, но в нём нет ничего подобного по "блочному" редактированию и автозаменам во всех документах.

Попробую покопаться в confluence и robohelp, может они решат проблему. Иначе погрязнем в груде документов и обязательно где-то что-то будет упущено.


  • 0

#7 SALar

SALar

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 2 177 сообщений
  • Город:Москва


Отправлено 13 Сентябрь 2018 - 09:40

Вероятно, вам сюда: http://author-it.ru/

 

1. Нужно принять концепцию: "Отдельно создание, отдельно публикация." У огромного количества людей с этим проблемы.

 

 

2. Инструменты.

Не надо "confluence". Это недоподелка от ребят в австралии спроектирована достаточно плохо. В австралии многое по другому. Лук они изобрести не смогли... Млекопитающие яйца несут. Вот и с "confluence" проблемы.

 

Есть куча инструментов. Как платных, так и бесплатных. AuthorIt считался самым крутым в среде техписов. Можно и RoboHelp и еще кучу. Только не "confluence".


  • 1

-- 

Сергей Мартыненко

Блог 255 ступеней

 


#8 uctepuka

uctepuka

    Новый участник

  • Members
  • Pip
  • 20 сообщений
  • ФИО:Алексеева Анна
  • Город:Москва

Отправлено 13 Сентябрь 2018 - 10:44

Вероятно, вам сюда: http://author-it.ru/

 

1. Нужно принять концепцию: "Отдельно создание, отдельно публикация." У огромного количества людей с этим проблемы.

 

 

2. Инструменты.

Не надо "confluence". Это недоподелка от ребят в австралии спроектирована достаточно плохо. В австралии многое по другому. Лук они изобрести не смогли... Млекопитающие яйца несут. Вот и с "confluence" проблемы.

 

Есть куча инструментов. Как платных, так и бесплатных. AuthorIt считался самым крутым в среде техписов. Можно и RoboHelp и еще кучу. Только не "confluence".

Про confluence поняла, спасибо большое за совет. Что-то только сайт слёг, не зарегистрироваться, ни темы нужные посмотреть ... ((


  • 0

#9 SALar

SALar

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 2 177 сообщений
  • Город:Москва


Отправлено 13 Сентябрь 2018 - 12:45

Попробуйте:

https://techwriters.ru/forum/

https://ru-techwrite...ivejournal.com/

 

И прочее. Я этим делом интересовался дюжину лет назад. С тех пор многое изменилось. "Философт" похоже почил. Обидно.

 

В общем ищите сообщество технических писателей.


  • 0

-- 

Сергей Мартыненко

Блог 255 ступеней

 


#10 Vasiliy

Vasiliy

    Гуру

  • Members
  • PipPipPipPipPipPip
  • 2 350 сообщений
  • ФИО:Касимов Василий
  • Город:Москва

Отправлено 14 Сентябрь 2018 - 10:23

Как почил??
  • 0

#11 tjupka

tjupka

    Новый участник

  • Members
  • Pip
  • 57 сообщений

Отправлено 16 Сентябрь 2018 - 05:44

Странно, что вы забыли о Release Notes, которые довольно легко автоматически собирать из Jira. По аналогии, статьи хелпа можно держать в системе контроля версий в разрезе функциональных модулей. А при наличии изменений в коде требовать от техписателя изменений в документации (попросите собирающего билд программиста написать вам нотификатор об изменениях кода для правки хелпа). Например, в VCS у вас есть папки:

- Продукт

-- Модуль

--- Код

--- Хелп на русском

--- Хелп на английском 

При наличии изменений в файлах папки "Продукт / Модуль / Код" техписателя информируют об имени изменённого модуля и характере правок. Техписатель исправляет файлы в папках "Продукт / Модуль / Хелп на русском" и "Продукт / Модуль / Хелп на английском".

 

Если общий хелп собирается из отдельных статей, выгружаемых из VCS (обычно это делается для компилируемых приложений, поэтому написать аналогичный хелповый сборщик для программиста - дело на пару дней), то в параллели не помешает хранить тексты Instant Help (об этом виде читайте в https://tjupka.blogs...lping-help.html) в этой же модульной папке VSC. 


  • 0

https://tjupka.blogspot.ru - из опыта тестировщика



Инструменты тестировщика: Командная строка
онлайн, начало 31 октября
Практикум по тест-дизайну 2.0
онлайн, начало 16 ноября
Программирование на Phyton для тестировщиков
онлайн, начало 26 октября
Тестирование производительности (JMeter)
онлайн, начало 2 ноября



Количество пользователей, читающих эту тему: 0

0 пользователей, 0 гостей, 0 анонимных

Яндекс.Метрика
Реклама на портале