кстати вот эта документация понравилась и по тексту и по оформлению
ну там немного подправить
но в целом "по всем правилам". если это не интерактивная дока, но все что нужно есть

https://www.liqpay.ua/documentation/api/information/status/doc
https://www.liqpay.ua/documentation/api/information/ticket/doc

единственное что я тут увидела из "нового" на что внимание не обращала

а разве типы и обязательность параметра с большой буквы писать нужно?

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

Коллеги, возник в отделе вопрос. Как корректно писать обращение к юзеру типа "вы", "вас" и т.д. в Руководствах пользователя - с заглавной буквы или нет?

с маленькой. С большой пишется когда лично вы обращаетесь к конкретной персоне и демонстрируете высокую степень уважения к тому, к кому обращаетесь.
http://phil.spbu.ru/nauka/ekspertnyi-universitet/lingvisticheskaya-klinika/voprosy/vopros-127

благодарю! Огромное спасибо. Я сейчас потратила 40 минут жизни на объяснение менеджеру, почему мы не пишем это все с заглавной буквы 🙈. Статья очень кстати

Речь о диалоговых формах? Или прям по тексту руководства? Можете пример привести, где написано "вы"/"вас". На мой взгляд, лучше избегать таких обращений, в нейтральной манере излагать..

по тексту, например, "Если вы ранее уже получали файл лицензии на ПО «...», то для изменения данных в лицензионном ключе вам необходимо подать заявку на обновление. "

>а разве типы и обязательность параметра с большой буквы писать нужно?

Если это просто текст, то с большой конечно, поэтому Required с большой - это слово, к нему применяются правила капитализации. А вот названия параметров и типов должны писаться as is, то есть ровно так, как они называются.

По поводу того, как это обозначить - это уж как вам удобнее будет. Тут сделано максимально формально и достаточно удобно пробегать взглядом, каждая колонка имеет своё значение. Поэтому в основном принято именно так, но это не значит, что всегда это будет самый удобный вариант. Можно вместо отдельных колонок ввести обозначения (звёздочки+сноски или цветом выделять), можно ячейку с названием или описанием загружать дополнительной инфой.

Всем привет ! Подскажите пожалуйста, с чего начать - чтоб стать техническим  писателем ? Работала инженером конструктором . Посоветуйте пожалуйста курсы или книги, вообщем все с чего начать можно изучение этой профессии . Спасибо 🙏🏽 извините , если такой вопрос уже задавали , совсем недавно в чате )

Не уверена, что это отличный, 10 из 10 совет, но я с нулём опыта в документации (до того полгода занималась маркетинговым контентом) пришла в разработку документации, и вот я здесь. Так что вы тоже можете так сделать.

Поэтому, если умеете делать уверенное лицо на собеседовании, просто апдейтните резюме и подумайте над сопроводительным письмом. На джуна точно должно хватить.

- Бесплатный курс от documentat.io на YouTube 🙂
- Нора Галь "Слово живое и мертвое", чтобы избавиться от канцелярита в письменной речи
- Поискать каналы в телеге на техписательскую тему, там много материалов и просто заметок о профессии (тут в чате наверняка о них упоминали, можно по поиску глянуть)
- Найти примеры документации, которая вам нравится
- Сделать портфолио из 1-2 технических текстов (например, как что-то настроить + описать какой-нибудь процесс)

По моему опыту это отличная программа минимум. И по времени не должна много занять

Сначала выбрать, хотите работать "для госзаказчика" или "для пользователя". если первое, то почитать ГОСТЫ на документацию и освоить Word.

https://t.me/technicalwriters/68702
обучение уже началось, возможно уже не получится залететь, спросите у Лизы, может разрешит

Спасибо всем за советы !!!

Привет. А на каком языке планируете писать?

Переходил в профессию как раз после того, как поработал  инженером-конструктором чуть больше года. Начал с того, что стал откликаться на вакансии. На второй пригласили на работу. Это было в 2008 году, но возможно, с тех пор подход не сильно изменился :)

На русском)

Спасибо !

Уже даже магистерскую программу открыли, да и куча курсов. Сейчас сложнее перейти....

Хм, на мой взгляд, бОльшие возможности обучения и более доступная информация по теме упрощают освоение и переход в профессию, а не наоборот.

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