Size: a a a

technicalwriters

2021 April 02

AY

Andrei Yemelianov in technicalwriters
Julia
Коллеги, всем привет. Кто-нибудь использует Markdown/ASCIIDoc как исходник для документации в Confluence?
Вроде кто-то по теме презентацию скидывал сюда года полтора назад
источник

AA

Anastasiia Antonenko in technicalwriters
Спасибо всем большое за ответы про стрелку!
источник

J

Julia in technicalwriters
Fox Mulder
А зачем???
просто ведем документацию как код, но заказчику нужно видеть её в Confluence
источник

FM

Fox Mulder in technicalwriters
Julia
просто ведем документацию как код, но заказчику нужно видеть её в Confluence
Ну и используйте обычные вложения )
источник

J

Julia in technicalwriters
Fox Mulder
Ну и используйте обычные вложения )
о чем именно речь?
источник

FM

Fox Mulder in technicalwriters
Julia
о чем именно речь?
Можно к blank-странице confluence прикрепить файл. Тогда при определённых условиях будет вестись нечто подобное git.
источник

J

Julia in technicalwriters
Fox Mulder
Можно к blank-странице confluence прикрепить файл. Тогда при определённых условиях будет вестись нечто подобное git.
эээ... а можно почитать/посмотреть, о чем вы говорите? Файл какого формата и расширения? При каких таких определенных условиях?
источник

J

Julia in technicalwriters
Julia
Коллеги, всем привет. Кто-нибудь использует Markdown/ASCIIDoc как исходник для документации в Confluence?
В общем выслушаю разные предложения. Может, кто-нибудь пользовался макросом для Confluence, который рендерит на лету markdond из url?
источник

FM

Fox Mulder in technicalwriters
Да просто скидывайте туда adoc or md files и обязательно соблюдайте 100% pixel perfection в наименовании файлов.
Тогда все изменения файлов будут видны в дереве и вы сможете в любой момент загрузить какой-либо из них.
источник

MC

Milkhail Che in technicalwriters
Что-то не могу создать опрос, администраторы отключили эту возможность?
источник

rK

rJIynbIu` KOT in technicalwriters
Fox Mulder
Да просто скидывайте туда adoc or md files и обязательно соблюдайте 100% pixel perfection в наименовании файлов.
Тогда все изменения файлов будут видны в дереве и вы сможете в любой момент загрузить какой-либо из них.
такая схема в конфлюенс с любыми типами файлов, у меня видосы так версионируются, но выше, как я понял, не нужно хранить файлы MD, их нужно отобразить по принципам MD, но в конфлюенс
источник

J

Julia in technicalwriters
rJIynbIu` KOT
такая схема в конфлюенс с любыми типами файлов, у меня видосы так версионируются, но выше, как я понял, не нужно хранить файлы MD, их нужно отобразить по принципам MD, но в конфлюенс
конечно, md хранятся в репозитории
источник

J

Julia in technicalwriters
Julia
конечно, md хранятся в репозитории
нужно рендерить их с изображениями на странице Confluence
источник

MC

Milkhail Che in technicalwriters
Кто как называет методы в руссой API документации?
1. По-английски, ибо ЦА понимает язык и он быстрее считывается. Например, GetObjectID.
2 По-русски, ибо дока русская всё же. Например, Получить ID объекта
источник

rK

rJIynbIu` KOT in technicalwriters
Julia
конечно, md хранятся в репозитории
чекни в маркетплэйсе атлассиан что-то типа этого https://marketplace.atlassian.com/apps/1211438/markdown-macro-for-confluence?hosting=server&tab=support
но насчет изображений я хз чё там как будет
источник

J

Julia in technicalwriters
да, я как раз на него смотрела, но там есть нюансы. Хотелось бы найти живого человека, который пользовался им
источник

BF

Bobba Fett in technicalwriters
Milkhail Che
Кто как называет методы в руссой API документации?
1. По-английски, ибо ЦА понимает язык и он быстрее считывается. Например, GetObjectID.
2 По-русски, ибо дока русская всё же. Например, Получить ID объекта
Название метода - это название метода.
источник

VI

Vladimir Izmalkov in technicalwriters
Bobba Fett
Название метода - это название метода.
+1. Кто как вызывается, то так сам и называется
источник

rK

rJIynbIu` KOT in technicalwriters
Julia
да, я как раз на него смотрела, но там есть нюансы. Хотелось бы найти живого человека, который пользовался им
у Семён Факторович спроси, у них на сайте вроде читал, что занимаются в том числе тем, что переводят доки из разных мест в конфу или обратно
источник

MC

Milkhail Che in technicalwriters
Bobba Fett
Название метода - это название метода.
я об этом
источник