Size: a a a

technicalwriters

2021 January 26

AL

Alla Lu in technicalwriters
Anton Samarin
А этот пункт вообще нужен? Обычно такие штуки можно сокращать в ноль
Нам такой документ "в наследство" достался. Мы при обновлении просто сделали новый "с нуля", а этот в архиве остался, нельзя было аннулировать
источник

AV

Anastasia Voronova in technicalwriters
Подскажите, пожалуйста, как правильно сформировать портфолио технического писателя, так, чтоб и будущий работодатель смог оценить мои навыки и у текущего не нарушить соглашение о конфиденциальной информации.
источник

M

Maeg in technicalwriters
Anastasia Voronova
Подскажите, пожалуйста, как правильно сформировать портфолио технического писателя, так, чтоб и будущий работодатель смог оценить мои навыки и у текущего не нарушить соглашение о конфиденциальной информации.
Задать прямой вопрос текущему работодателю, что можно использовать, как чистить доки. У меня несколько раз прокатывало. Поэтому в портфолио есть документы с текстами "здесь был скриншот", например :) Ну и вообще от большого документа можно обычно оставить одно оглавление и четыре показательных страницы :)
источник

V

Vera in technicalwriters
🙌 Всем привет!
                                                                                     
#wanted_tw #технический_писатель #москва #вакансия #job #мск #офис #аналитик                                                                      
                                                                                     
🔹Локация: Москва (ЦАО)
🔹 Занятость: fulltime (офис)
🔹Вилка: 100k – 130k net
🔹 Вакансия: Ведущий технический писатель
🔹Компания: Эвокарго                                                                    
📩 Контакт: @Vera_K_V
   
      Основные направления: разработка программно-аппаратных комплексов навигации и управления беспилотных автомобилей; разработка систем обработки и анализа данных сенсоров различной природ;, разработка нейросетевых методов и моделей обработки данных; разработка программно-аппаратных комплексов картирования; разработка программно-аппаратных комплексов для подключенных машин; разработка программно-аппаратных комплексов диспетчеризации и мониторинга флота беспилотных машин др.

         Условия:
📌 ТК РФ;
📌 ДМС после испытательного срока;
📌 Профессиональный и молодой коллектив;
📌Профессиональный рост;
📌 Участие в высокотехнологичных проектах.


         Профессиональный опыт:
📌Опыт работы техническим писателем или аналитиком (от 2-х лет);
📌 Умение перенести на бумагу “слова” конструкторов и разработчиков;
📌 Умение создавать, редактировать, иллюстрировать и адаптировать технический материал, умение одновременно работать с несколькими проектами, способность разбираться в незнакомых областях;
📌 Умение планировать и укладываться в сроки.
источник
2021 January 27

СФ

Семён Факторович... in technicalwriters
Мы тут посовещались админской коллегией и решили ввести пару новых правил чата.

Нам поднадоели постоянные разговоры про «один стандарт документирования хуже другого» и «всюду ГОСТ и честным людям жизни нет».

Почему-то эти разговоры не приводят к продуктивным дискуссиям, а раз за разом скатываются в обесценивание работы коллег и неконструктивные жалобы на жизнь.

С сегодняшнего дня в чате запрещены любые безапелляционные, дискриминационные и негативно оценочные суждения относительно:

— российских ГОСТов или других стандартов документирования;
— специалистов, работающих в разных областях нашей профессии и с разными документационными стандартами;
— зарплат в разных областях наших профессии.

Единичное нарушение этого запрета влечет за собой предупреждение, повторное — бан на длинный срок.


✅ Можно:
— «Я не могу разобраться в требованиях к документу Х из ГОСТ 34, ответьте мне на пару вопросов по ним, пожалуйста»
— «Какова средняя зарплатная вилка ГОСТ-техписателя в России?»
— «Куда мне лучше расти — в DocOps-инженера или документатора API?»
— «В среднем англопишущий документатор API зарабатывает больше ГОСТ-техписателя» (это объективный факт рынка труда)


❌ Нельзя:
— «Документационный стандарт Х бесполезен и никому не нужен»
— «Техписатели, использующие документационный стандарт Х, получают в 10 раз меньше остальных и умрут в нищете»
— «Документы с рамочками — атавизм, все, кто их пишут — дураки и не лечатся»
— «Пользовательская документация — тупиковая ветвь профессионального роста, все крутые чуваки и чувихи пишут только OpenAPI в сваггере за 300кк/сек»
источник

D

DbSergey in technicalwriters
Александр Парень
Правила чата сообщества технических писателей

Убедительно просим Вас ознакомиться с правилами, дабы избежать возможных проблем.

1. Общие положения:

1.1. Администраторы всегда правы.
1.2. За нарушение правил администраторы имеют полное право дать пользователю бан!
Администраторы имеют полное право давать бан без предупреждения.
1.3. Все выкладываемые участниками (фотографии, картинки, материалы) должны быть так или иначе связаны с темой данного чата и не нарушать авторских прав, законодательства РФ и лицензионных соглашений.

Электронные книги, пособия и другие материалы, которые представлены официально в интернет-магазинах, а не в свободном доступе запрещены к выкладыванию. Так же нельзя выкладывать ссылки или кряки, пропатченный софт, серийные ключи, кейгены и т.п.

Мы уважаем авторское право.

1.4. Все вопросы и обсуждения должны соответствовать нормам.
1.5. Для связи с администрацией пишите в ЛС.

- @Nick_Volynkin
- @ayemelianov
- @SashP84
- @akhorkov
- @factorized
- Андрей
- @glu0n
- @LittleSunnyboy

2. Разрешено (можно):

2.1. Описать вопрос по своей проблеме. Сразу и одним сообщением. Без прелюдий «кто может помочь».
2.2. Опубликовать ссылку на какое-нибудь ИТ-мероприятие или конференцию связанное с тематикой сообщества или IT-индустрией.
2.3. Опубликовать инструкцию, лайфхак или видеоотчёт с какого-нибудь мероприятия и.т.п.
2.4. Посоветовать нужное ПО для профессии технического писателя.
2.5. Подискутировать в разумных пределах и без оскорблений по тематикам технического писательства и ИТ-индустрии.
2.6. Обратиться администратору с обращением по нарушению авторских прав или правил.
2.7. В целом разрешено обсуждение (комментирование) любых опубликованных сообщений относительно тематики данного чата.
2.8. Участники имеют полное право адекватным русским языком указать на какую-либо ошибку.
2.9. Для HR: опубликовать вакансию с тегом #wanted_tw, городом и с контактами к кому обращаться. Можно дать только ссылку на компанию работодателя, без дополнительных лозунгов.
2.10. Кандидатам: опубликовать своё резюме и портфолио с тегом #ищу_работу. Все публикуемые материалы не должны нарушать авторских прав и NDA.


Просьба: все посты на тему личных знакомств для свиданий, иных встреч, прогулок, прыщей на теле, войн, теорий заговора, политики, предсказаний и т.п. обсуждать в других чатах и сообществах. Такие посты сразу будут удаляться без предупреждения.

3. Запрещено:

3.1. За размещение рекламы или ссылок не имеющих отношения к сообществу, карается баном от недели и выше. Для этого есть другие ресурсы и сообщества.
3.2. Мы не приветствуем открытый мат или просто оскорбления в сообщениях, заданных вами, адресованных кому-либо, в таких случаях посты будут удалены, а пользователь получает бан. Уважайте друг друга!
3.3. Сообщения не должны содержать оскорбления (будут удалены).
3.4. Агрессия и провокация на создание флуда в сообщениях.(Бан).
3.5. Неуместные "троллинги", шутки запрещены. (Бан)
3.6. Запрещена антиреклама сообщества и чата, бан.
3.7. За угрозы предоставляется бан!
3.8. Также запрещена пропаганда: наркотиков, насилия, и прочих злых деяний. (Бан)
3.9. Оскорбление администраторов за, то что пост был удален, правила не нравятся, и другие подобные негативы, тоже карается баном.
3.10. Запрещен флуд, спам.(Бан)
3.11. Запрещено размешать изображения и .gif документы следующего вида: порнография, эротика, трупы животных или людей, детское порно и.т.п. (Бан)
3.12. За выпады на вакансии будем банить, не надо набрасываться, на тех, кто публикует, не устраивает, проходите мимо, или будьте корректны в выражениях, все условия уточняйте в личке. Пользователь набросившейся с оскорблениями на рекрутера сразу получает бан на месяц. Все условия по вакансиям уточняйте в личных переписках.
Пользуясь пунктом 2.8 правил, хочу обратить внимание администрации на следующие ошибки в тексте правил:

1. Пункт 1.3, второй параграф, первое предложение: "также" должно быть написано слитно.
2. Пункт 1.4: не описано, что имеется в виду под термином "норма". Было бы уместно упомянуть законодательство РФ и, например, здравый смысл.
3. Пункт 2.2: перед "связанное" нужна запятая, а вместо "связанное" следует написать "связанные"
4. Пункт 3.1: караться может "размещение", а не "за размещение". Если мы пишем" за размещение карается", то надо указать, кто именно карается (автор сообщения).
5. Пункт 3.2: "сообщение" не может быть "задано". Сообщение может быть отправлено или опубликовано, а задан может быть вопрос.
6. 3.7: бан не может быть предоставлен, он может быть выдан.
7. 3.8: перед "и" не нужна запятая.
8. 3.9: лексический треш, не раскопал.
9. 3.11: gif - это файл, а не документ.
10. 3.12: после "набрасываться" не нужна запятая; перед "не устраивает" нужна точка с запятой; после "не устраивает" нужно тире; после "пользователь" нужна запятая; после "рекрутера" нужна запятая.

Спасибо.
источник

NV

Nick Volynkin in technicalwriters
DbSergey
Пользуясь пунктом 2.8 правил, хочу обратить внимание администрации на следующие ошибки в тексте правил:

1. Пункт 1.3, второй параграф, первое предложение: "также" должно быть написано слитно.
2. Пункт 1.4: не описано, что имеется в виду под термином "норма". Было бы уместно упомянуть законодательство РФ и, например, здравый смысл.
3. Пункт 2.2: перед "связанное" нужна запятая, а вместо "связанное" следует написать "связанные"
4. Пункт 3.1: караться может "размещение", а не "за размещение". Если мы пишем" за размещение карается", то надо указать, кто именно карается (автор сообщения).
5. Пункт 3.2: "сообщение" не может быть "задано". Сообщение может быть отправлено или опубликовано, а задан может быть вопрос.
6. 3.7: бан не может быть предоставлен, он может быть выдан.
7. 3.8: перед "и" не нужна запятая.
8. 3.9: лексический треш, не раскопал.
9. 3.11: gif - это файл, а не документ.
10. 3.12: после "набрасываться" не нужна запятая; перед "не устраивает" нужна точка с запятой; после "не устраивает" нужно тире; после "пользователь" нужна запятая; после "рекрутера" нужна запятая.

Спасибо.
👏
источник

АП

Александр Парень... in technicalwriters
Поправим
источник

CV

Cro Vin in technicalwriters
DbSergey
Пользуясь пунктом 2.8 правил, хочу обратить внимание администрации на следующие ошибки в тексте правил:

1. Пункт 1.3, второй параграф, первое предложение: "также" должно быть написано слитно.
2. Пункт 1.4: не описано, что имеется в виду под термином "норма". Было бы уместно упомянуть законодательство РФ и, например, здравый смысл.
3. Пункт 2.2: перед "связанное" нужна запятая, а вместо "связанное" следует написать "связанные"
4. Пункт 3.1: караться может "размещение", а не "за размещение". Если мы пишем" за размещение карается", то надо указать, кто именно карается (автор сообщения).
5. Пункт 3.2: "сообщение" не может быть "задано". Сообщение может быть отправлено или опубликовано, а задан может быть вопрос.
6. 3.7: бан не может быть предоставлен, он может быть выдан.
7. 3.8: перед "и" не нужна запятая.
8. 3.9: лексический треш, не раскопал.
9. 3.11: gif - это файл, а не документ.
10. 3.12: после "набрасываться" не нужна запятая; перед "не устраивает" нужна точка с запятой; после "не устраивает" нужно тире; после "пользователь" нужна запятая; после "рекрутера" нужна запятая.

Спасибо.
У вас в п. 4 "кататься" описка. :)
источник

AE

Artem Egorov in technicalwriters
DbSergey
Пользуясь пунктом 2.8 правил, хочу обратить внимание администрации на следующие ошибки в тексте правил:

1. Пункт 1.3, второй параграф, первое предложение: "также" должно быть написано слитно.
2. Пункт 1.4: не описано, что имеется в виду под термином "норма". Было бы уместно упомянуть законодательство РФ и, например, здравый смысл.
3. Пункт 2.2: перед "связанное" нужна запятая, а вместо "связанное" следует написать "связанные"
4. Пункт 3.1: караться может "размещение", а не "за размещение". Если мы пишем" за размещение карается", то надо указать, кто именно карается (автор сообщения).
5. Пункт 3.2: "сообщение" не может быть "задано". Сообщение может быть отправлено или опубликовано, а задан может быть вопрос.
6. 3.7: бан не может быть предоставлен, он может быть выдан.
7. 3.8: перед "и" не нужна запятая.
8. 3.9: лексический треш, не раскопал.
9. 3.11: gif - это файл, а не документ.
10. 3.12: после "набрасываться" не нужна запятая; перед "не устраивает" нужна точка с запятой; после "не устраивает" нужно тире; после "пользователь" нужна запятая; после "рекрутера" нужна запятая.

Спасибо.
4. Пункт. Орфографическая ошибка в начале предложения.
источник

АП

Александр Парень... in technicalwriters
Все предложения по правилам в личку админам.
источник

D

DbSergey in technicalwriters
Cro Vin
У вас в п. 4 "кататься" описка. :)
Спасибо, исправил
источник

D

DbSergey in technicalwriters
Artem Egorov
4. Пункт. Орфографическая ошибка в начале предложения.
Спасибо, исправил
источник

D

DbSergey in technicalwriters
Александр Парень
Все предложения по правилам в личку админам.
Так это ж не мне надо, а группе 😉
источник

АП

Александр Парень... in technicalwriters
DbSergey
Так это ж не мне надо, а группе 😉
Тем более) Спасибо.
источник

AD

Alyona Devon in technicalwriters
а кто-нибудь знает зачем программисту знать точный тип параметра ответа?
при приеме параметров каждый тип по разному обрабатывается?

обычно все методы которые я с примерами давала, то там все верно, через постмен что получила, то и вставляю

а вот древние 2015 года оказывается с ошибками, где-то нужны кавычки, где-то нет (ну то есть где-то string, где-то integer, при чем это просто потому что так разработчик сделал, ведь целое число и там и там, зачем передавать как строка, а не число целое)
https://monosnap.com/file/lAj0xzrLiTPmduDMjfcgtVHbuxSYty

и второй вопрос, какие еще сайты используются, которые предоставляют обработчики вебхуков (дают ссылку, на нее летит событие когда затригерилось и по этой ссылке можно прочитать ответ)
Если постмен для тестирования апи, вебхуки он не обрабатывает
источник

R

Roht in technicalwriters
Alyona Devon
а кто-нибудь знает зачем программисту знать точный тип параметра ответа?
при приеме параметров каждый тип по разному обрабатывается?

обычно все методы которые я с примерами давала, то там все верно, через постмен что получила, то и вставляю

а вот древние 2015 года оказывается с ошибками, где-то нужны кавычки, где-то нет (ну то есть где-то string, где-то integer, при чем это просто потому что так разработчик сделал, ведь целое число и там и там, зачем передавать как строка, а не число целое)
https://monosnap.com/file/lAj0xzrLiTPmduDMjfcgtVHbuxSYty

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

R

Roht in technicalwriters
так что хорошо бы знать, вестимо
источник

R

Roht in technicalwriters
да даже питону надо при необходимости явно преобразовывать числа в стринги, чего уж там, иначе конкатенация работать не будет
источник

R

Roht in technicalwriters
а насчет вебхуков — я точно знаю, что в ReadyAPI можно читать респонс от вебхуков, но он платный. есть опенсорсная версия. но не уверен, что в ней такая функциональность в наличии
источник