Добавьте это правило в свой стайлгайд. Стайлгайд главнее пруфридера.

Например,
https://mcs.mail.ru/help/ru_RU/cases-elk/elk-u18
Моя статья сделанная в гугл.доксе и вставленная уже cms.
Код красиво оформлен как блочный список.

на самом деле принципы выделения unix-based stuff должны быть такие, как в man утилит. И, насколько я помню, фигурные скобки там не используются - только круглые и квадратные.

А для чего круглые?

https://man7.org/linux/man-pages/man7/man-pages.7.html

Много программ писал для этого чуда. Помню зависть сокурсников при обработке экспериментов. Дополнительных библиотек к нему так и не нашёл. Но он был у меня не первый...

Носитель языка и специалист в сфере написания статьи вычитывают и правят ваш текст. Потом согласуют с вами. Это если нужен результат,- принятие статьи в журнал на рецензирование.

Всем привет! Я Таня, HRD в documentat.io, буду периодически набегать с вакансиями техписателей) Ещё я немножко редактор, поэтому вдвойне рада присоединиться к чату✌️

Что такое HRD?

HR Director по идее)

всё так)

Привет! Я тоже с вакансией 😊

Я Света, рекрутер #tecforce. Мы занимаемся разработкой ПО.

Ищу коллегу – Технического писателя в #СПб.
Текущие проекты -https://tecforce.ru/clients/#ministerstvo-oboronyi-rf

Задачи: подготовка тех. документации на ПО и ее согласование, оформление нормативных документов.

Важен о/р техническим писателем, знание требований #ГОСТ_34 и/или #ГОСТ_19

От нас - все официально, по ЗП – гибко, соц. пакет с дмс, корпоративными скидками и бонусами, гибридный график работы. Вопросы – буду рада ответить в личку @Sveduzh
#technicalwriter #техническийписатель #техническаядокументация #techwriters #tw_wanted

добавьте, пожалуйста, тег #tw_wanted

ок! )

а можно еще уточнить
если нужно сделать сноску под таблицей
и в самой таблице больше чем 1 место, о котором нужно больше рассказать в примечании
и не создали спец стиль для этого (как в книгах маленькие цифры 1,2,3) то есть можешь оперировать только звездочками что ли (или у бутстрапа есть спец клас для этого может)

то это вообще норм 3 звездочки подряд ставить?
потому что если 1 звездочка, а цифрами внизу - не всегда может и понятно что вообще к какому месту

я бы цифры использовал для сносок

имхо, 3-4 звезды ещё норм смотрится, но 5 и больше перебор

ну просто обычную цифру не поставишь) нужна маленькая в уголке в таком случае

и еще такой вопрос (старую документацию приводитм к одному виду. так как частично на свагере, частично просто табличной версткой)

и вот описание параметра ответа куда лучше выводить?:
в отдельную таблицу (как параметры запроса, даже если это 1 параметр),
в строке перед примером (как тут)
или комментарием к параметру в ответе (через //)

маленькая делается через ¹, в маркдауне для неё иногда работает ^, либо прямо тэгами можно сделать