LINUX.ORG.RU

Markdown как базовый формат для пользовательськой документации

 ,


0

3

для своего проекта есть полтора десятка страниц пользовательськой документации. сейчас она хранится в google docs. это удобно тем что есть нормальное парное редактированние, версионирование с человеческим лицом, аннотации и прочие плюшки. неудобно тем что на выходе (интересен html и pdf) получе получаем неуправляемое нечто: предустановленные неизменяемые? стили (оба формата); картинки включенные через урл (html), которые нужно дополнительно процессить; каждая буква представленная как entity. Например

р

Поэтому ищется вариант при котором не сильно пострадает «за», но поубавится «против».

Пока в голове крутится только один вариант: хранить все в markdown.

что мне не дает спокойствия в случае markdown: нормальных редакторов не так много (cейчас смотрю на dillinger). паралельного редактирования бесплатно нигде нет, аннотаций вроде тоже. но наиболее сложной проблеммой сейчас видится «вставка» картинок в документ. ведь это значит что их придется предварительно заливать руками на 3rd-party сервис.

Собственно у меня следующий вопрос: а что Вы юзаете для пользовательськой документации? Как вы вообще ее готовите?

В общем если у вас есть истории успеха или советы для моего случая —добро пожаловать в тред. Также приглашаю Vit как пользователя ЛОРа, который знаком с темой маркдауна немного более чем обычный лорчанин.

ps: latex не предлагать. человек который занимается документаций это **обычний** человек, а не програмист. + у него нет времени на освоение этого инструмента.

★★★★★

Последнее исправление: ZuBB (всего исправлений: 7)
Ответ на: комментарий от xcariba

и чем оно лучше дилинжера? тот умеет гит(хаб) сам, без вмешательства пользователя

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от ZuBB

очень ценное сообщение. Вы либо разшифруйте либо не мешайте пожалуйста

google docs, формат экспорта, маркдаун, картинки, 3rd-party сервис, парное редактирование.


Если рассматривать google docs и проблемы экспорта — поднимай собственный wiki-like сайт, confluence там или еще что. Еще лучше ownCloud. И экспортируй как угодно.

Или нужен оффлайн маркдаун редактор, с возможностью онлайн доступа к готовой документации? Покупай приватный github доступ, редактируй офлайн, заливай гитом. Или используй bitbucket, у него есть бесплатные приватные репозитории.

Или что конкретно тебе нужно?

Маркдаун, гуглдокс, нормальный редактор, удобно вставлять картинки, кони, люди?

habamax ★★★
()

Документация это же текст. Для текста есть гит. Пользователю на своем сайтике оставить ссылочку «скачать мокрые письки pdf»

makoven ★★★★★
()
Ответ на: комментарий от xcariba

сорцы дилинжера открыты. так что тоже можна офлайн.

картинки заливаются вместе с текстом

этого не понял. обьясни.

ZuBB ★★★★★
() автор топика
Последнее исправление: ZuBB (всего исправлений: 1)
Ответ на: комментарий от makoven
  • пользователю нужно дать ссылку на инсталлятор, в котором все уже включено.
  • держать пдф(бинарник) в репе не кошерно когда он (и не только он) формируется из маркдауна
  • гит это космос. обычный пользователь не обязан знать его. дилинжер умеет в гитхаб автоматом
ZuBB ★★★★★
() автор топика
Ответ на: комментарий от ZuBB

Одним коммитом заливаются все изменения, не надо каждую картинку заливать куда-то. Но это гит. я так понимаю он не подходит.

xcariba ★★
()

В общем если у вас есть истории успеха

у меня есть история успеха, вот: http://docs.unity3d.com

весь usermanual в markdown (точнее, в multimarkdown, т.к. оригинальный md слишком примитивен).

если есть конкретные вопросы — задавай.

waker ★★★★★
()

На гитхабе так много кто делает:)

pon4ik ★★★★★
()

Могу подсказать офлайн-редактор ReText (но ни о какой совместной работе по сети в нём, разумеется, и речи не идёт).

svobodka_fighter
()
Ответ на: комментарий от xcariba

Но это гит. я так понимаю он не подходит

гугл докс имеет поддержку версионирования. поетому если таки переезжать с него, то хотелось бы также сохранить поддержку этой фичи. поэтому в 1ю очередь рассматриваются гитхаб, битбакет, owncloud? и тп. так что фраза «гит не подходит» не совсем коректна. в случаях с гитхаб/битбакет он будет присутствовать. другое дело что если пользоваться дилинжером то он берет (почти) всю работу с гитом на себя, подсовывая пользователю простой интерфейс.

но такой трюк не пройдет с картинками ибо для их использования в тексте они (уже) должны быть доступны с какого-то сервера..

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от svobodka_fighter

Выглядит неплохо, но навскидку есть одно «но»: нет никакой версии под офтопик, а рецепт для ручной сборки выглядит страшновато

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от waker

пока есть два вопроса: (а) в каком редакторе набирается текст? (б) можна посмотреть сырци этих доков?

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от ZuBB

(а) в каком редакторе набирается текст?

в любом по желанию оффлайн, + есть свой вебсервис.

(б) можна посмотреть сырци этих доков?

их нет в публичном доступе, но могу показать пример доки по выбору. что именно ты там хочешь увидеть?

waker ★★★★★
()
Ответ на: комментарий от ZuBB

ps: приятно удивлен что от тебя есть хоть какая-то польза кроме офтопа, флуда и самозабана.

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от waker

есть свой вебсервис

ссылкой поделитесь, пожалуйста

но могу показать пример доки по выбору.

пожалуйста если можна

ZuBB ★★★★★
() автор топика
Ответ на: комментарий от ZuBB

ссылкой поделитесь, пожалуйста

сожалею, но нету ссылки. работает только во внутренней сети предприятия.

пожалуйста если можна

ну вот например

http://pastebin.com/hr4k5xxH

исходник этой страницы

waker ★★★★★
()

git+rst+sphinx-doc Есть rtfd.org, где хостится документация. Имеется репозиторий на гитхабе. Делаешь push и документация благодаря настроенным хукам автоматически пересобирается. Более чем удобно.

Kilte ★★★★★
()
Ответ на: комментарий от Amp

Amp, waker

посмотрел. макрдаун выглядит попроще.

но тем не менее спасибо

ZuBB ★★★★★
() автор топика

Марк не обижается?

YLoS ★★★
()

наверно таки остановлю свой выбор на markdown

ZuBB ★★★★★
() автор топика

азкидок или рст.

маркдаун - обычно для пыхеров и прочих маркдаунов...

buratino ★★★★★
()

Мы храним всю документацию в markdown. Нормальное совместное редактирование достигается путём использования Git.

что мне не дает спокойствия в случае markdown: нормальных редакторов не так много

редакторов просто не нужно. Формат простой как три копейки, у нас даже переводчик в первый день научился в него. Результаты редактирования смотреть сразу в браузере.

ведь это значит что их придется предварительно заливать руками на 3rd-party сервис.

Не нужно чужие сервисы. Картинки хранить на своем веб-сервере. Хранить рядом с markdown-файлами документации, в каталоге images. У нас сервак работает на линуксе, а показывалка документации - сайт на ruby on rails с, кажется, puma в качестве веб-сервера, но всё это совершенно неважно

stevejobs ★★★★☆
()

Я маркдаун мало редактирую. В обычном саблайме.

Можно вот это попробовать https://stackedit.io/

Если навороты в разметке важнее читаемости, тогда asciidoc.

Vit ★★★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.