Size: a a a

technicalwriters

2021 April 09

OM

Oleg M in technicalwriters
это читерство 🤔😡  🙂
источник

KG

Kamilla Garifullina in technicalwriters
Зато один раз написал и свободен
источник

ДЧ

Дарья Чернавина... in technicalwriters
Всегда должна быть Библия и заповеди, ага.
источник

KG

Kamilla Garifullina in technicalwriters
Никто ж не говорит, что стайлгайд прибит гвоздями
источник

KG

Kamilla Garifullina in technicalwriters
Если оппонент сможет аргументированно переубедить - правки и в стайлгайд вносятся
источник

KG

Kamilla Garifullina in technicalwriters
Ведь нет цели "только так и не иначе", а "давайте делать нашу доку лучше"
источник

NV

Nick Volynkin in technicalwriters
да
источник

NN

Nadezhda Napolskaya in technicalwriters
Можно ридабилити посчитать, если в результате правки она повысилась
источник

СФ

Семён Факторович... in technicalwriters
твиттером принесло
источник

СФ

Семён Факторович... in technicalwriters
это working draft стандарта языка C++, совершенно официальный документ
источник

СФ

Семён Факторович... in technicalwriters
кажется, даже продающийся за деньги
источник

СХ

Саша Хо in technicalwriters
Для себя пришел к такой формуле: текст стал лучше, если количество слов уменьшилось, нужные единицы мысли сохранились, лишние убраны.

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

Например, в гипотетической инструкции для смартфона «смахните вправо» — это лаконично, но пожилой человек, который в первый раз держит в руках смартфон, вряд ли поймёт, что нужно сделать.
источник

FM

Fox Mulder in technicalwriters
Миш, увы, никак. Только нечетное кол-во ревьюеров на апрув мержа.
Или корпоративный стайлгайд.
источник

ДЧ

Дарья Чернавина... in technicalwriters
Пошла на йогу, стою собакой мордой в низ, говорят "Поставьте ноги уже". А я: "Куда уже? Я могу их к рукам подтянуть, могу в бёдрах сдвинуть". Ну и часто у меня были приколы, что просят поставить коробку справа: "А справа относительно вас или меня?" Вот тут тоже вопрос: "смахните вправо" показывается справа в вертикальном положении смартфона, горизонтальном или в обоих случаях? А верно для них? Лаконичность должна быть уместной, короче)
источник

Э

Эльфарран in technicalwriters
😂😂😂😂
источник

МО

Михаил Осокин... in technicalwriters
На мой взгляд:
- если не можешь объяснить правку, то и не надо её делать;
- если не обязан объяснять правку (сам несёшь ответственность за итоговый текст), то и не надо её объяснять.
источник

AA

Anastasiia Antonenko in technicalwriters
не сразу поняла, что тут про "Уже", а не "ужЕ" 😂
источник

SK

Serg Kulakov in technicalwriters
Всем привет. Пробовал ли кто-нибудь "патчить" sphinx?
Исходники в rst. Задача — заменить символ-разделитель в роли menuselection.

Использую этот хак: https://github.com/sphinx-doc/sphinx/issues/7006#issuecomment-573077539

Всё прекрасно работает для конкретного документа: вношу изменения в conf.py этого документа, собираю HTML, символ-разделитель меняется.

У нас 70+ документов, постоянно добавляются новые. Править каждый conf.py — так себе затея.

Может ли кто-то подсказать, как распространить эти две строчки кода сразу на все документы?
источник

ДЧ

Дарья Чернавина... in technicalwriters
Я ещё хотела написать, что более узко. Но мне сказали "уже", значит "уже".
источник

NV

Nick Volynkin in technicalwriters
Что такое «conf.py этого документа»? Конфиг общий на весь проект, все 70 документов.
источник