Разве? Я думал, коммерческая тайна защищается законом. А почему не работает?

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

Мы же не на Хабре

Т.е. работает при условии X. А X никто не хочет делать.

Мы в интернете - и здесь все у всех видно :)

Как ты думаешь сколько контор реально заморачиваются оформить КТ в нужном виде? Вопрос риторический, если что

+

Да, там очень много нюансов. Я пока за свой стаж (а он уже совершеннолетний) видела две конторы, реально оформлявшие все по законодательству. Тот еще гемор.

@bo_larson И, кстати, если при таком подходе вы попробуете устроиться в какую-нибудь US- или EU-based компанию, то если они узнают про подобные сливы, то карма у вас будет очень сильно подпорчена. Это аналогично тому, как пренебрегать такой штукой, как Insider Trading Policy и несерьезно относится к SEC (https://www.sec.gov/). Все до поры до времени - никто же не знает, куда вас занесет проф. ветка развития.

Как говорится, береги честь смолоду :)

всем привет!
ищу технических писателей в команду (аж 3 человека 😂), с опытом разработки документации по разработке и внедрению ПО и ПАК. Проектная деятельность, рассматриваем и на частичную занятость.  

если кратко, то нужен человек, который приведет документы из рабоче-программистского в формальный, займется написанием технических заданий по 34 и 19 ГОСТ, также не боится написаний инструкций пользователя/администратора, ПМИ и др.

работать можно удаленно, можно из офиса, рассматриваем на частичную занятость или в штат, оформление ИП/ТК.
Название компании: ГК Urban Intel
Офис: Москва

если интересно или пообщаться более предметно — пишите в личные сообщения @ju_dusha

#tw_wanted

Причем тут юэс и еу конторы и русские положения о ком. тайне?

И сравнение этого с инсайдерской инфой и sec - это, конечно, сильно

Всем привет! Меня зовут Михаил Кулаковский, я делаю систему онлайн-документации для software/hardware проектов, о которой вчера говорил Павел @zhovner.

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

Мы сами разработчики, и понимаем частые боли команд разработки по поводу поддержания документации в актуальном виде. Но еще хотелось бы пообщаться именно с техническими писателями, я уверен, в вашей работе есть куча своих нюансов.

Готов пообщаться со всеми, кто хочет поделиться своим опытом и идеями. В идеале, в формате недолгого zoom-звонка: для этого просто напишите мне в личку, или запишитесь через эту форму: https://calendly.com/klkvsk/docma. Обсудим инструменты, подходы, боли и их возможные решения.

Кратко набросаю тезисы и фичи для понимания, куда мы движемся:
- работает в браузере как SaaS/self-hosted
- wysiwyg, но со строгой структурой (без каши из стилей, готовые типографские блоки для оформления текста и вставки медиа)
- командная работа с разделением ролей (писатель/редактор/переводчик)
- версионирование, черновики, история правок
- примеры кода с использованием реального кода из вашего репозитория
- встроенный редактор диаграмм, графиков, таблиц, изображений
- импорт из markdown и экспорт в markdown, в т.ч. прямо в репозиторий
- публикация на отдельном поддомене или вашем собственном домене, с вашим брендингом, либо экспорт готового статического сайта

Проект называется Docma (https://docma.io), сейчас пилим MVP, поэтому пока открытого доступа нет, но на сайте через форму внизу можно записаться в лист ожидания.

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

документация к сайту, направлена на студентов/старших школьников
мне нравится документация Яндекса, а что еще?

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

Книжки по писательскому мастерству могу вечером собрать и скинуть, они не на рабочем ноуте. Так же стилистика и прочее, ну и что есть по техписательству.

Кое-что есть в документах группы, можно поиском глянуть.

#wanted_tw

Компания: Облачный провайдер Serverspace
Город: Санкт-Петербург
Формат работы: Удаленно, part-time

Всем привет
Ищу технических писателей на разработку инструкций для клиентов облачного провайдера. Нужны люди, которые разбираются в облачных технологиях и инструментах для разработчиков, DevOps-специалистов, системных администраторов. Желательно разбираться в Kubernetes, Terraform, настройке серверов и приложений на разных ОС. Либо иметь возможность изучить тему.

Работаем удаленно, парт-тайм, по договору ГПХ, с самозанятыми или ИП, можем оформить в штат. Необходимо выполнять план по количеству выпускаемых инструкций в месяц. В работу входит написание инструкции на русском и английском языках и публикация на сайте.

Важно! Требуется грамотный русский и английский язык.

Пишите в личные сообщения @svt_sharapova

спасибо

передаю то, что давали мне в этом чате:
В основном, конечно, книжки на английском ради английского, например Elements Of Style за авторством William Strunk. Или Keys to Great Writing, Последнюю, если перевести на русский. то получится почти Ильяхов (утрирую) 🙃

Техписателю не всегда тексты надо писать. Мы пишем доку для разработчиков и у нас техписы помогают разработчикам придумывать правильные названия апишкам.
По апишкам, конечно, лучше смотреть доку к той платформе, на которой эти самые апишки работают.  Это помогает соблюсти конвенции и прочие стайлгайды. Но стайлгайды обычно выдают готовый набор рекомендаций. А без английского артефакты апишки грамотно не обозвать.

Чтобы почитать рассуждения о том, как сообразить хороший программный интерфейс, мне понравилась книжка The Little Manual of API Design, Jasmin Blanchette, Trolltech, a Nokia company. Там разбирается общий подход к наименованию  и составлению апишек к UI фреймворку на примере QT.

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

The Curious Case of the Misplaced Modifier by Bonnie Trenga
Every Page is Page One by Mark Baker
Keys to Great Writing by Stephen Wilbers and Faith Sullivan
Microsoft Manual of Style, 4th edition by Microsoft Corporation
Handbook of Technical Writing by Gerald J. Alred, Charles T. Brusaw, and Walter E. Oliu
Managing Writers: A Real World Guide to Managing Technical Documentation by Richard L. Hamilton
Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content by Alan S. Pringle and Sarah S. O'Keefe
Technical Writing Principles, Strategies & Readings by Diana C. Reep

Modern Technical Writing by Andrew Etter, очень небольшая и компактная, зашла