Size: a a a

Технические писатели

2021 December 17

АД

Александр Дегтярев... in Технические писатели
Возможно.
источник

АД

Александр Дегтярев... in Технические писатели
И попробуйте потом программистов заставить их использовать.
источник

ET

Eduard Tibet in Технические писатели
Docbook тоже можно редактировать в emacs или vim
источник

АД

Александр Дегтярев... in Технические писатели
А ещё нужно выучить новую разметку
источник

АД

Александр Дегтярев... in Технические писатели
А маркдаун все знают, кто так или иначе оформлял реадми к репозиторию.
источник

АД

Александр Дегтярев... in Технические писатели
Вики конечно совсем не тоже, что и Docbook, но нам не удалось заставить программистов вести доку в Вики.

Поэтому мы начали делать условно хорошую документацию рядом с кодом на Гитхабе в надежде когда-то потом из всего этого сгенерировать сносную онлайн штуку с рюшечками, экспортом в PDF и красивую :)
источник

ET

Eduard Tibet in Технические писатели
На гитхабе может использоваться любой из: https://github.com/github/markup/blob/master/README.md#markups (если имеется в виду рендеринг из коробки).
источник

АД

Александр Дегтярев... in Технические писатели
Отлично, спасибо. Я почитаю и, может быть тоже переедем.
источник

ET

Eduard Tibet in Технические писатели
Маркдаун - это формат, синтаксис. Аналогично любым языкам разметки. Кстати, DITA-документы тоже можно писать в блокноте. Никто не запрещает.
источник

ET

Eduard Tibet in Технические писатели
Теперь по сути. У меня сложилось мнение, что вы только начинаете свой путь в технической документации. Если это так, то вам надо взять небольшую паузу и составить список того, что вам надо изучить _сначала_ до момента выбора какого-либо инструмента. иначе вы просто выберете не то, а потом переделывать что-либо будет сложно (или очень дорого). Совет такой: сначала выдохните :) Потом посмотрите на следующую схему: форматы - инструменты - методология. По каждому из них выпишите то, что вы знаете. Далее дополните тем, что не знаете. Почитайте о каждом пункте, который вы внесете в список. У вас будет какое-то представление. Если не знаете где о почитать о каком-нибудь пункте -  спросите в этом чатике.
Сейчас же вы пытаетесь ухватиться за что-то, о структуре чего не имеете представления. Это ошибочный путь.
источник

G

Grolribasi in Технические писатели
Под требования весьма подходит AsciiDoc + Antora. Можно через гит, есть топики и ключи, можно будет создавать пдф скоро, а при желании расширить до ворда. Разбивка на версии тоже есть.
источник

АД

Александр Дегтярев... in Технические писатели
Класс. Подскажите, а оно инклюды тоже умеет? Это когда кусок текста в кучу статей вставлен.
источник

G

Grolribasi in Технические писатели
Можно целиком или по кускам. Моё самое любимое - это когда делается один топик для повторного использования - типа шаблон. А потом его делаем инклуд в другой три раза. Один раз будет, например, установка, второй - удаление, третий - обновление. Удобно, когда шаги примерно одинаковые, но писать заново лень. В AsciiDoc чень много крутой магии. Но при этом его понять просто и использовать просто. Если надо, всегда есть куда копнуть.

Короче, да, можно инклуды. И не только.
источник

АД

Александр Дегтярев... in Технические писатели
Спасибо, пойду тогда читать документацию) Как-то так у меня в голове и выглядел инструмент, на который я хочу спрыгнуть с МедиаВики.
источник

G

Grolribasi in Технические писатели
Не за что. Документация на asciidoctor. Просто обычно выводит устаревший сайт в поиске.
источник
2021 December 18

IM

Igor Mironovsky in Технические писатели
это не алиас, термин называется "семантическое окончание URL", вся тема по этому вопросу тут: https://ru.wikipedia.org/wiki/%D0%A7%D0%B5%D0%BB%D0%BE%D0%B2%D0%B5%D0%BA%D0%BE%D0%BF%D0%BE%D0%BD%D1%8F%D1%82%D0%BD%D1%8B%D0%B9_URL
источник

НС

Надежда Сидякова... in Технические писатели
Спасибо
источник

D

Dana in Технические писатели
Всем привет)
А подскажите, есть ли тут Технические писатели из сферы, например, машиностроения?
источник

V

Vasiliy in Технические писатели
А какой вопрос?
источник

D

Dana in Технические писатели
Общий, если можно так выразиться. Только вступаю на "тропу" тех. писателя. Может что-то  посоветуете: литературу, курсы, видеоуроки... Платные, но проверенные дистанционный курсы тоже актуальны будут.
Заранее благодарна.
источник