Сообщений в теме: 10

[uctepuka]

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

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

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

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

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

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

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

[BadMF]

 

 

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

 

 

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

 

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

[Spock]

 

 

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

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

 

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

[Little_CJIOH]

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

[BadMF]

 

 

 

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

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

 

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

 

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

 

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

 

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

 

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

[uctepuka]

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

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

 

 

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

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

[SALar]

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

 

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

 

 

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

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

 

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

[uctepuka]

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

 

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

 

 

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

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

 

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

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

[SALar]

Попробуйте:

https://techwriters.ru/forum/

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

 

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

 

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

[Vasiliy]

Как почил??

[tjupka]

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

- Продукт

-- Модуль

--- Код

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

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

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

 

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