Size: a a a

DocOps-сообщество

2020 August 03

ЕД

Егор Доронин... in DocOps-сообщество
Либо слишком деталей неважных много
источник

ЕД

Егор Доронин... in DocOps-сообщество
Да и что уж, для разработчиков тоже
источник

ИЦ

Игорь Цупко... in DocOps-сообщество
никогда не использовал plantuml для uml.
источник

NV

Nick Volynkin in DocOps-сообщество
Игорь Цупко
С удивлением обнаружил, что в PlantUml есть заготовки спрайтов под кубенетесы, авсы и кучу других полезных вещей https://crashedmind.github.io/PlantUMLHitchhikersGuide/
Спасибо, что напомнил! Мне уже кидали эту ссылку, а я забыл поделиться )
источник
2020 August 04

rK

rJIynbIu` KOT in DocOps-сообщество
Привет. Кто может стать ментором или кем-то подобным по следующей теме? Я меньше пол года как работаю тех писом, вся документация в организации в ворде, для релиза по каждой версии продукта переводится в пдф. В данный момент накопилось больше 50 ворд-файлов, потихоньку количество увеличивается. С их оформлением и стилизацией беда: всё везде по своему, делалось в разное время и разными людьми. Захотелось сделать всю документацию в rST, а затем генерить из него хтмл (что пока кажется ненужным) и пдф (ну возможно Ворд, если совсем без него обойтись не получится). На настоящий момент попробовал сфинкс, перевел и сгенерил с пары документов хтмл. Ну и трудности с переводом docx в rST, не могу сам разобраться с луа фильтрами, чтобы по минимуму вручную редактировать получающийся rST после пандока. И генерацией пдф откуда бы ни было, пандок не хочет, ругается и сфинкс тоже.
Короче, как я понял многие уже так работают с документацией, и это не что-то сверхъестественное, поэтому прошу поделиться опытом и помочь разобраться.
P.S  Сори за многобукв, просто чтобы была понятна ситуация.
источник

NV

Nick Volynkin in DocOps-сообщество
rJIynbIu` KOT
Привет. Кто может стать ментором или кем-то подобным по следующей теме? Я меньше пол года как работаю тех писом, вся документация в организации в ворде, для релиза по каждой версии продукта переводится в пдф. В данный момент накопилось больше 50 ворд-файлов, потихоньку количество увеличивается. С их оформлением и стилизацией беда: всё везде по своему, делалось в разное время и разными людьми. Захотелось сделать всю документацию в rST, а затем генерить из него хтмл (что пока кажется ненужным) и пдф (ну возможно Ворд, если совсем без него обойтись не получится). На настоящий момент попробовал сфинкс, перевел и сгенерил с пары документов хтмл. Ну и трудности с переводом docx в rST, не могу сам разобраться с луа фильтрами, чтобы по минимуму вручную редактировать получающийся rST после пандока. И генерацией пдф откуда бы ни было, пандок не хочет, ругается и сфинкс тоже.
Короче, как я понял многие уже так работают с документацией, и это не что-то сверхъестественное, поэтому прошу поделиться опытом и помочь разобраться.
P.S  Сори за многобукв, просто чтобы была понятна ситуация.
Привет. Нормальная задача, точно не сверхъестественная.
источник

v

vladimir in DocOps-сообщество
а затем генерить из него хтмл (что пока кажется ненужным)

вот пока кажется не нужным, не придумывайте себе работу ради работы. Word - Файл - Сохранить как - pdf.
источник

IC

Ivan Cheban in DocOps-сообщество
И в Ворде можно стили настроить, все документы привести под один стиль. Ну и потом из них пдф
источник

IC

Ivan Cheban in DocOps-сообщество
Я пока не научился красивые пдф генерить через пандок из rst или Markdown.
источник

rK

rJIynbIu` KOT in DocOps-сообщество
vladimir
а затем генерить из него хтмл (что пока кажется ненужным)

вот пока кажется не нужным, не придумывайте себе работу ради работы. Word - Файл - Сохранить как - pdf.
Я честно говоря не представляю как в наше время можно вообще предоставлять какой-то продукт без онлайн справки или документации. И возникла ситуация, что отдел техподдержки обязали сделать сайт-портал с инструкциями-руководствами, то есть частями моей документации в ворде, а заполняется этот портал Маркдауном. В итоге я документов 20 переводил в маркдаун, правил кучу инфы вручную и заливал на их портал. То есть по факту доки онлайн нужны.
источник

rK

rJIynbIu` KOT in DocOps-сообщество
Ivan Cheban
И в Ворде можно стили настроить, все документы привести под один стиль. Ну и потом из них пдф
Сейчас первым делом приведу весь ворд к одному шаблону по стилям. Это в любом случае давно надо было сделать, плюс при переводе в любой другой формат упростит его доработку. Ну а по генерации, на хабре была статья как из сфинкса сначала делали латекс, а потом уже пдф, результат выглядел отлично, правда у меня вообще не получилось сделать что-то похожее, как по мне очень сложная настройка перевода, ну и с латексом разбираться надо.
источник

AR

Anna Ryutina in DocOps-сообщество
rJIynbIu` KOT
Сейчас первым делом приведу весь ворд к одному шаблону по стилям. Это в любом случае давно надо было сделать, плюс при переводе в любой другой формат упростит его доработку. Ну а по генерации, на хабре была статья как из сфинкса сначала делали латекс, а потом уже пдф, результат выглядел отлично, правда у меня вообще не получилось сделать что-то похожее, как по мне очень сложная настройка перевода, ну и с латексом разбираться надо.
я как представлю что тебе нужно под один формат 50+ доков подвести, так у меня глаз дергается) в вордах делать это крайне напряжно. Мы (как люди еще далекие от доков в коде) используем приложение Help&Manual - ее тут не любят, она платная, но для начала вообще супер. Мы все доки перевели в формат пдф за пару месяцев. И вся пдф документация  теперь генерится по одному шаблону из единого источника по нажатию кнопки. + там можно делать html и прочие форматы.
источник

IC

Ivan Cheban in DocOps-сообщество
rJIynbIu` KOT
Сейчас первым делом приведу весь ворд к одному шаблону по стилям. Это в любом случае давно надо было сделать, плюс при переводе в любой другой формат упростит его доработку. Ну а по генерации, на хабре была статья как из сфинкса сначала делали латекс, а потом уже пдф, результат выглядел отлично, правда у меня вообще не получилось сделать что-то похожее, как по мне очень сложная настройка перевода, ну и с латексом разбираться надо.
А можно ту статью на Хабре ссылку?
источник

rK

rJIynbIu` KOT in DocOps-сообщество
Ivan Cheban
А можно ту статью на Хабре ссылку?
источник

IC

Ivan Cheban in DocOps-сообщество
Спасибо!
источник

IC

Ivan Cheban in DocOps-сообщество
Похоже, это то, что я давно ищу — инструкция, полученная путем проб и ошибок.
источник

H

Hartmann in DocOps-сообщество
Интересная статья.
В своё время она бы очень мне помогла... Хорошо, оно уже закончилось.

Как вижу Латех, Ворд и Пдф в одном предложении глаз дёргаться начинает.
источник
2020 August 05

PK

Phil Kulin in DocOps-сообщество
Ivan Cheban
Похоже, это то, что я давно ищу — инструкция, полученная путем проб и ошибок.
Только надо понимать, что в 2020 году надо просто использовать xelatex. Тогда там целой главы не будет. Про шрифты
источник
2020 August 06

LG

Lev Grishin in DocOps-сообщество
Привет. Подскажите, кто-нибудь из вас использует подготовку документации в Confluence с последующим согласованием там же? (с или без привязки документа к Jira)
источник

iv

iakov v in DocOps-сообщество
используем
источник