ET
То, что приведено выше - без интерактива.
Size: a a a
2020 April 24
CD
Ну кстати для меня например в API очень важны примеры с curl иногда, так как бывает в той же Jira Cloud API нужно искать в community примеры вызова
А это скриптиком нельзя сделать?
АШ
Коллеги, прошу совета.
Документ в 2 частях, при этом в акте приема-передачи документации он указан одной строчкой. Допустимо ли в графе "Количество листов" в акте приема-передачи документации указать две цифры?
<кол-во листов в части 1> + <кол-во листов в части 2>
Документ в 2 частях, при этом в акте приема-передачи документации он указан одной строчкой. Допустимо ли в графе "Количество листов" в акте приема-передачи документации указать две цифры?
<кол-во листов в части 1> + <кол-во листов в части 2>
АП
А это скриптиком нельзя сделать?
Иногда времени просто мало, сидеть гадать. Хочется сразу пример строки запроса
2020 April 25
IG
Коллеги, подскажите, с чего начать путь в документировании API
L
Ivan Gribachev
Коллеги, подскажите, с чего начать путь в документировании API
2020 April 26
2020 April 27
RV
Всем привет. Помогите со Sphinx. Хочу единый источник. В общей справке есть два раздела, например, хелп для юзера и хелп для админа. У них одинаковый раздел Введение, за исключением одного подраздела. Сделал Введение отдельным файлом и инклюдом его в документы. А как сделать, чтобы отличающаяся часть попала только в юзера, а в админа не попала? Директива :only тут не подойдет, т.к. оба документа генерятся целиком в единую онлайн справку
SY
.. include:: introduction.rst
start-line: 1
end-line: <N>
где N — последняя строка общей части. Но end-line указывайте только для юзера, для админа опустите.
start-line: 1
end-line: <N>
где N — последняя строка общей части. Но end-line указывайте только для юзера, для админа опустите.
SY
либо вынесите общую часть в файл, а не все введение. и для админа “допишите”.
EN
привет. делюсь очередной статьей из нашего техблога про опыт преподавания технического документирования и в целом про размышления на эту тему https://medium.com/xsolla-tech/technical-writing-as-educational-program-16d8ec7b73fd
BN
привет. делюсь очередной статьей из нашего техблога про опыт преподавания технического документирования и в целом про размышления на эту тему https://medium.com/xsolla-tech/technical-writing-as-educational-program-16d8ec7b73fd
💪🏻
2020 April 28
L
Roman Vostrikov
Всем привет. Помогите со Sphinx. Хочу единый источник. В общей справке есть два раздела, например, хелп для юзера и хелп для админа. У них одинаковый раздел Введение, за исключением одного подраздела. Сделал Введение отдельным файлом и инклюдом его в документы. А как сделать, чтобы отличающаяся часть попала только в юзера, а в админа не попала? Директива :only тут не подойдет, т.к. оба документа генерятся целиком в единую онлайн справку
выше предложили хорошее решение, также еще можно сделать conditional include с помощью .. only:: и вроде еще какое-то расширение есть для этого же ifconfig кажется
RV
выше предложили хорошее решение, также еще можно сделать conditional include с помощью .. only:: и вроде еще какое-то расширение есть для этого же ifconfig кажется
У всех этих директив есть один нюанс как я понял, они не работают на уровне заголовков. Т.е. нельзя отдельный раздел сюда запилить, а туда нет. Можно только строку или параграф, например.
2020 April 29
ET
Roman Vostrikov
У всех этих директив есть один нюанс как я понял, они не работают на уровне заголовков. Т.е. нельзя отдельный раздел сюда запилить, а туда нет. Можно только строку или параграф, например.
В смысле, "заголовок, раздел и все внутри" или только "текст заголовка"?
ET
привет. делюсь очередной статьей из нашего техблога про опыт преподавания технического документирования и в целом про размышления на эту тему https://medium.com/xsolla-tech/technical-writing-as-educational-program-16d8ec7b73fd
На самом деле, образовательные программы есть, но до стандарта они не дотягивали от слова "совсем".
ET
Как видно по тексту программы - из ИТ там нет ничего :)
EN
кажется у них одна и та же программа залита для двух направлений