Size: a a a

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

2020 February 26

AY

Andrei Yemelianov in DocOps-сообщество
Александр Мокрушин
если из HM в DOC, а из DOC в MD?
Или все плохо со стилями?
не самый удачный вариант (только что попробовал)
источник

iv

iakov v in DocOps-сообщество
А зачем вообще в такой цепочке md? он ведь явно не конечный продукт? возможно, есть более короткий и прямой способ получения конечного продукта из chm?
источник

AY

Andrei Yemelianov in DocOps-сообщество
iakov v
А зачем вообще в такой цепочке md? он ведь явно не конечный продукт? возможно, есть более короткий и прямой способ получения конечного продукта из chm?
цель моего исследования - проверить, можно ли уйти с HM вообще
источник

iv

iakov v in DocOps-сообщество
если hm генерирует chm, то это compiled html, архив с html-файлами, грубо говоря. эти html-файлы можно оттуда извлечь и дальше работать с ними, не привлекая doc
источник

А

Александр Мокрушин in DocOps-сообщество
iakov v
если hm генерирует chm, то это compiled html, архив с html-файлами, грубо говоря. эти html-файлы можно оттуда извлечь и дальше работать с ними, не привлекая doc
Из hm можно сразу делать html
источник

А

Александр Мокрушин in DocOps-сообщество
Разработчики hm обещают конвертацию в MD в будущих версиях

http://helpman.it-authoring.com/viewtopic.php?t=15517
источник

NV

Nick Volynkin in DocOps-сообщество
Andrei Yemelianov
Вопрос ко всем: а есть ли какие-то инструменты, чтобы преобразовать XML, который используется в Help and Manual, в markdown?
XSLT называется такой инструмент :)
Но писать придется много.
источник

NV

Nick Volynkin in DocOps-сообщество
Andrei Yemelianov
Вопрос ко всем: а есть ли какие-то инструменты, чтобы преобразовать XML, который используется в Help and Manual, в markdown?
Но вообще, чем плох вариант сделать HTML и из него Md?
источник

AY

Andrei Yemelianov in DocOps-сообщество
Nick Volynkin
Но вообще, чем плох вариант сделать HTML и из него Md?
Попробую
источник

NV

Nick Volynkin in DocOps-сообщество
Он хорош тем, что для обработки HTML есть очень много инструментов, больше чем для других форматов. Считай, на любом популярном языке ты что-то найдёшь
источник
2020 February 27

NK

ID:0 in DocOps-сообщество
​​Что делать, чтобы документацию читали?
Принести документацию ближе к пользователю. Прямо туда, где он столкнётся с проблемой и будет нуждаться в документации.

Хороший пример: доки по синтаксису языка Elm принесли в сообщения об ошибках в синтаксисе. Теперь эти сообщения помогают изучить синтаксис и исправить ошибку.
источник

NK

ID:0 in DocOps-сообщество
Читатель @ejiek подсказал ещё один пример документации прямо в месте ошибки — язык Rust.

Команда rustup docs --book показывает общую документацию языка Rust.

Все ошибки содержат краткое описание и заканчиваются номером ошибки:

For more information about this error, try rustc --explain E0271.

Команда rustc --explain E0271 показывает справку по ошибке и помогает её исправить.
источник
2020 February 28

NK

ID:0 in DocOps-сообщество
Курс по документации для инженеров.
Google выпустил курс по техдокументации для инженеров. Он состоит из двух частей общей длительностью не больше восьми часов.

Вот и решился вопрос, чем заняться на длинных выходных. :)
источник

AR

Anna Ryutina in DocOps-сообщество
а это типо можно просто читать и не нужно записываться на курсы?
источник

NV

Nick Volynkin in DocOps-сообщество
Кажется, без записи, да.
источник

AR

Anna Ryutina in DocOps-сообщество
о тогда круто
источник
2020 February 29

NK

ID:0 in DocOps-сообщество
​​Пока кто-нибудь только задумывается о переезде с допотопных CMS на docs-as-code, продвинутые ребята из Lisk переезжают с Markdown на AsciiDoc и Antora.

Хоть я и перетащил на reST пару десятков проектов, для меня в этой статье много полезного. Например, Lisk вместе со сменой инструмента переработали структуру доки. Их топологию можно использовать как «таблицу Менделеева»: про каждый сегмент подумать, а что из нашей документации сюда ложится? Как люди это найдут, как будут читать? А если ничего нет, не стоит ли написать?
источник
2020 March 01

AB

Arina Ballerina in DocOps-сообщество
Коллеги, привет, ай нид хелп от Hugo специалистов. Решила разучить еще один генератор, генерить сайты через 'hugo server -D' получается, но когда пытаюсь через 'hugo -D'  сложить результат в папочку, дизайн пропадает, то есть на выходе я получаю голый html без стилей и картинок. В инструкциях везде написано как деплоить через разные инструменты, а хочу просто сгенерить статический сайт. Я чего-то не того хочу?   Hugo v0.62.0, macOS.
источник

NV

Nick Volynkin in DocOps-сообщество
Arina Ballerina
Коллеги, привет, ай нид хелп от Hugo специалистов. Решила разучить еще один генератор, генерить сайты через 'hugo server -D' получается, но когда пытаюсь через 'hugo -D'  сложить результат в папочку, дизайн пропадает, то есть на выходе я получаю голый html без стилей и картинок. В инструкциях везде написано как деплоить через разные инструменты, а хочу просто сгенерить статический сайт. Я чего-то не того хочу?   Hugo v0.62.0, macOS.
Просто hugo без параметров?
источник

AB

Arina Ballerina in DocOps-сообщество
Nick Volynkin
Просто hugo без параметров?
ага, я попробовала команду hugo и с -D и без, и тему напрямую прописывать в командной строке, ничего не помогает.
источник