Вход | Регистрация
 

Софт для создания инструкций

Софт для создания инструкций
Я
   Dirk Diggler
 
25.08.20 - 14:03
Постоянно приходится делать инструкции к продуктам. Условно говоря - запчасти к автомобилям.
Вопрос - чем автоматизировать бы?

Стопудов должны быть какие-то решения.

Типа стили блоков настроил, блоков "текст", "пиксельное изображение", "векторный рисунок" набросал, а он тебе макет на выходе - всё в едином стиле, с колонтитулами и т.п.

Нашел Dr.Explain, Help&Manual, но они чисто под документирование софта заточены - с чертежами и прочим не очень.
   Злопчинский
 
1 - 25.08.20 - 14:07
laTEX
   Злопчинский
 
2 - 25.08.20 - 14:08
опять же - что мешает сделать в том же ворде нужный шаблон (со всеми стилями и пр) и наполняй потом..?
   Dirk Diggler
 
3 - 25.08.20 - 14:12
(2) Не, ну ворд инструмент могучий, даже статические сайты в нем делали )))) Но мне автоматизировать надо. А не геморроизировать.

Ты в ворде массу инструкций в одном стиле пробовал сделать-то сам?

И LaTEX стоить оставить гикам.
Я не готов каждого ответственного за документацию обучать этой резине. Нужен простой инструмент. Типа визуального редактора статей вконтаче. Для средних умов.
   Dirk Diggler
 
4 - 25.08.20 - 14:14
кстати, по этой же причине Help&Manual не подошел, он сложный. Ща докторобъясни пробовать буду
   Злопчинский
 
5 - 25.08.20 - 14:14
(3) " ответственного за документацию " - ну как бы подразумевается что ответсвенный за документацию квалифицирован в области своей деятельности "выпуск документации". или не? типа маша-оператор, давай еще пусть она будет "ответственной за документацию"..? тады ой ;-)
   yzimin
 
6 - 25.08.20 - 14:15
confluence

как это выглядит у этих ребят можно посмотреть тут https://doc.maxoptra.com/docs/pages/viewpage.action?pageId=21987587
   Dirk Diggler
 
7 - 25.08.20 - 14:15
(5) нет, ответственный за документацию разбирается в предметной теме. в запчастях.
   Dirk Diggler
 
8 - 25.08.20 - 14:16
(6) он умеет pdf генерить или типа того?
   Dirk Diggler
 
9 - 25.08.20 - 14:17
а, вижу. это просто вики покрасивше. Не, не совсем то.
   jbond
 
10 - 25.08.20 - 14:21
(1) - ну да, у него там нужны сложные химические формулы и музыка
   Dirk Diggler
 
11 - 25.08.20 - 14:25
Блин, и Dr.Explain не подошел.
Колонтитулы - на все страницы, титульного листа не понимает(колонтитул будет на всех листах, включая титульный), в стили оформления таблиц не умеет вовсе....
   Злопчинский
 
12 - 25.08.20 - 14:32
(4) если чего внятного найдешь - отпишись, тоже интерсено
   Злопчинский
 
13 - 25.08.20 - 14:33
(7) понятно. еще один "программист-бетонщик" ;-)
   8 bit
 
14 - 25.08.20 - 15:04
(11) наши все в confluence верстают. Потом оттуда выгружают в нужном виде: с названиями рисунков, с колонтитулами, с форматированием абзацев. И если результирующий документ требует корректировки, то корректируют его непосредственно в конфлюенсе, потом перевыгружают.
   Dirk Diggler
 
15 - 25.08.20 - 15:29
(14) локально стоит? мне он всю кириллицу пропустил при экспорте в pdf. пустой файл вывел
   jbond
 
16 - 25.08.20 - 15:38
(0) э... а чертежи как бе в автокадах, компасах и прочих открытых аналогах делаются
   Dirk Diggler
 
17 - 25.08.20 - 15:40
(16) речь не о чертежах. А о сборке разнообразного контента в PDF с минимальными когнитивно-временными затратами.
   Krendel
 
18 - 25.08.20 - 15:42
(17) А почему именно ПДФ?
   Dirk Diggler
 
19 - 25.08.20 - 15:43
(14) confluence, как прочие, вообще не умеет колонтитулы делать нормальные.
Реально так и до ворда можно дойти обратно....

(18) классика жанра. Можно CDR. МОжно не знаю что.
Из чего полиграфические конторы еще печатают книжки?
   MouHacTaBHuk
 
20 - 25.08.20 - 15:46
(0) попробуйте Notion. Он блочного типа – инструкции на нем накидывать одно удовольствие
   Dirk Diggler
 
21 - 25.08.20 - 16:10
(20) Да, удобен. Но визуально не кастомизируется. Корпоративный стиль не выдержать....



пипец. ничего нет. похоже, правда придется обертку для LaTEX накидать...
   mikecool
 
22 - 25.08.20 - 16:22
(20) посмотрел - из него сохраниться во что бы то ни было не получилось
да и как то не удобно рисовать в нем что либо
   tldr
 
23 - 25.08.20 - 23:31
(0) HTML. Он может работать как с текстом, так и с изображениями, и со стилями, и с вектором. И на нем легко программировать. Напишешь свой интерфейс, немного научишься вебу заодно, глядишь и потом устроишься куда-нибудь на зарубежную работу за евро или за баксы.
   wt
 
24 - 26.08.20 - 09:01
Набери в поисковике слово «ИЭТР». И рой туда. Есть и бесплатные продукты, но ограниченные функционалом. Технические руководства нормальных фирм готовятся на этих технологиях.
   Garykom
 
25 - 26.08.20 - 09:46
(23) +1 за HTML
   wt
 
26 - 26.08.20 - 09:59
+(24) специализированное ПО готовит технические руководства, а отображение пользователю формируется в формате НТМЛ. Но наше СПО оно корявое( имхо). Я в свою бытность искал и нашёл контору, которая решала эту проблему через плагины к експлорер. И если бы был хороший интерес у заказчика, был готов сделать сам. Трудозатраты, но это того стоило.
   Dirk Diggler
 
27 - 26.08.20 - 12:27
(24) seamatica.seaproject.ru
Боюсь у них спросить о цене ))) Как самолёт стоит стопудов. )
   Dirk Diggler
 
28 - 26.08.20 - 12:28
а, да чо спрашивать, вон калькулятор. базовая на 10 юзеров - 450 тыщ. перебор ))
   wt
 
29 - 26.08.20 - 12:46
(28) это для моряков. Там дорого. Есть попроще, как плагин для експлорера.
   Dirk Diggler
 
30 - 26.08.20 - 13:03
(29) Technical Guide Builder уже подешевле кстати... Надо изучить.
 
 Рекламное место пустует
   Dirk Diggler
 
31 - 26.08.20 - 13:27
Technical Guide Builder оказался концептуально похож то, что надо, но реально это огромный такой комбайн, для больших предприятий.
В качестве индивидуального инструмента не пойдет, слишком сложный все равно.

Плагинов никаких связанных с ИЭТР не нашел.

По итогам, будем все-таки Confluence ставить, и настраивать стили через CSS. Он тоже не блочного типа, но пока лучшее из того, что перебрал.
Разработчикам Dr.Explain мысли про блочный редактор закинул. Пока как-то так.
Всем спасибо.
   Fragster
 
32 - 26.08.20 - 13:37
маркдаун в гите + нормальные стили для перегона в html.
greenshot для скриншотов (картинки, к сожалению, в гите блобами лежат, но тут по другому, наверное, никак)
plantuml в гите для схем
   Dirk Diggler
 
33 - 26.08.20 - 13:41
(32) это хорошо для гиков. Латекс вон уже предлагали.

А с документацией работают технари попроще, от "сохи". Какой там маркдаун и стили для перегона, нету времени их учить.

Нужен простой WYSIWYM-редактор.
   Fragster
 
34 - 26.08.20 - 13:47
стили для перегона - они один раз настраиваются, а затем вся документация получается в едином стиле. Так-то хоть шаблон ворда настроить можно и научить людей тыкать в стили вместо ручного форматирования. Я когда диплом делал, почти все страдали от перенумерации рисунков формул и таблиц. А со стилями и ссылками - все нормально работало.
   Fragster
 
35 - 26.08.20 - 13:49
просто надо инструментом знать как пользоваться, а то будет как в анекдоте:
Приходит мужик в магазин с бензопилой и жалуется:
- Вот, я у Вас пилу купил - дорогую, в инструкции написано, что ей за
час можно напилить 5 кубометров дров. А я, как ни стараюсь, больше 4
кубометров за час напилить не могу!
Продавец:
- Хм, сейчас проверим (дергает за шнур-пускатель и заводит бензопилу).
Покупатель:
- Ой!!! А что это она зажужжала???

ну а маркдаун - совсем простой инструмент. плантумл посложнее, но тоже норм. опять же - версионность и совместная работа нормальная, а на выходе получаем портал с документацией нормальный.
   Dirk Diggler
 
36 - 26.08.20 - 13:51
(34) пробую ща в Typora сделать небольшой мануал.

Сплошной простыней идет файл - это сильный минус, разделения по главам нет, путаница в структуре и заголовках будет.

Изображения вставляются по ссылке на файл, что тоже не оч. хорошо. Но вообще да, это вариант №2, если конфлюенс не взлетит.
   Fragster
 
37 - 26.08.20 - 13:59
vs code, поделенный пополам, слева маркдаун, справа превью
   Fragster
 
38 - 26.08.20 - 14:02
   fisher
 
39 - 26.08.20 - 14:04
Я тоже за маркдаун. Просто подобрать под него wysiwyg редактор поудобней и все. Его сейчас по-моему все популярные редакторы и инструменты документирования поддерживают.
Выгружай потом в любой формат. Аскидок вот еще был/есть, но маркдаун лучше взлетел.
   Fragster
 
40 - 26.08.20 - 14:04
   Fragster
 
41 - 26.08.20 - 14:10
Про сплошную простыню - просто можно делать на каждый раздел по файлу
   Dirk Diggler
 
42 - 26.08.20 - 14:13
(39) вообще-то я как раз хочу уйти от wysiwyg, так как это слишком затратно.
Мне нужен wysiwyM.
   Dirk Diggler
 
43 - 26.08.20 - 14:17
(35) >на выходе получаем портал с документацией нормальный.

Задача портала не стоит. Задача стоит - получение PDF для исполнения в полиграфическом виде и для скачивания.
   wt
 
44 - 26.08.20 - 14:18
(31) именно этот я когда-то покупал. На нем делали иэтр для Сухого. Купил 10 лицензий, обучился. Сделали несколько руководств. Оказался очень проблемным с точки зренияпривязки к другой отрасли, да и эксплуатации. Потом прошёл слух, что и Сухой от него отказался. Так что не рекомендую. Я стал искать другую платформу, моряков отказал-дорого и много темных мест. Натолкнулся на плагин, вот только сейчас все поуничтожал, подсказать не смогу, надо заново искать.
   Fragster
 
45 - 26.08.20 - 14:20
для пдф latex :)
маркдаун тоже можно, конечно
   Fragster
 
46 - 26.08.20 - 14:21
Если версионность не нужна, то для pdf норм зайдёт шаблон в ворде, только надо людей ворду обучить. Подавляющее большинство этого не умеет.
   Dirk Diggler
 
47 - 26.08.20 - 14:23
(46) чего скрывать, нормально доки в ворде делать не умею и я. Всё разъезжается, стили постоянно надо править после копипаста, и проч. Адская работа.
Тут применимы законы Паркинсона, если что-то может пойти не так - оно обязательно пойдет. Поэтому и нужен инструмент, где ничего не так пойти не может.
   pavig
 
48 - 26.08.20 - 15:11
(0)
Конфлюенсом пользуемся, очень нравится. Но только в онлайне, в PDF не выгружаем.
Однако ж в PDF можно и средствами браузера сохранять, если сам конфлюенс не умеет... если это подходит конечно... сам не пробовал.
   Dirk Diggler
 
49 - 26.08.20 - 15:12
(48) Да, была такая мысль, пдф браузером делать. Но. браузер не умеет работать с номерами страниц, поэтому оглавление нормальное не получится.
   Dirk Diggler
 
50 - 26.08.20 - 15:13
(48) конфлюенс умеет. у него очень бедненько в плане инструментов редактирования колонтитулов, но это мы попробуем побороть через CSS.
   fisher
 
51 - 26.08.20 - 17:16
(42) Ну дык маркдаун - это как раз про это. Это максимально простой и "нативный" язык разметки простых документов.
Не нравится гиковость текстового wysiwym - для него можно найти и плюшевые wysiwym-редакторы. Хотя он создавался как раз из расчета, чтобы можно было обходиться без них и работать с плоским текстом.
wysiwyg в связке с маркдауном - это просто предпросмотр результата разметки с конкретной "шкуркой".
   Fragster
 
52 - 26.08.20 - 17:31
(49) скорее всего и с маркдауном пролетите. а вот латекс да, запросто сможет.
   Fragster
 
53 - 26.08.20 - 17:35
но нафига в современном мире доки в виде пдф - не совсем понятно. счас даже к стиралкам инструкции онлайн.
   fisher
 
54 - 26.08.20 - 17:44
Для маркдауна попробуйте typora.io
Но всякие "издательские" хитрости типа колонтитулов в pdf - это уже настраивается заголовками для конкретных конвертеров, которые такое умеют и тому подобными финтами.
Потому что это уже не вопрос схемы документа, а вопрос его представления.
   fisher
 
55 - 26.08.20 - 18:02
Примечательно, что вся справка/документация по typora написана на маркдауне и отображается ей точно так же как и любые другие маркдаун документы, с которыми она работает. То есть можно в нее же подглядывать как в пример оформления документации. Фишка typora в том, что они очень удобно и прикольно совмещают одновременно маркдаун-разметку и пресловутый wysiwyg.
   Peltzer
 
56 - 26.08.20 - 18:36
А почему Wikia не подошла?
   Dirk Diggler
 
57 - 26.08.20 - 22:25
(53) Вопрос к законодателям. Законы о защите прав потребителей и удаленной торговле. Ну и в самом деле, если чел живет в деревне, где инет по талонам - что теперь, лишать его инструкции?
   Dirk Diggler
 
58 - 01.09.20 - 10:13
Всё в целом взлетело. Даже PDF генерит. Не удалось конечно все задумки реализовать, но в общем - летит.

Есть спецы у кого по этому конфлюенсу, кому подхалтурить надо? Кое-какие работы все же хотелось заказать бы, только ума не дам, как их искать-то вообще. на фрилансе их вроде нет, или не там ищу.


Список тем форума
Рекламное место пустует  Рекламное место пустует
ВНИМАНИЕ! Если вы потеряли окно ввода сообщения, нажмите Ctrl-F5 или Ctrl-R или кнопку "Обновить" в браузере.