возможно) вообще хз кого там ищут, если честно

я про описание какого-то компонента, если он универсальный(может использоваться ещё где-то)

Ну я вот не уверен, что описание участка кода стрёмного удобнее хранить в истории коммитов, а не рядом со стрёмным участком :)

Это документация

тэкс.. в чат ты кидала 11.11.. сорри..
а такое ощущение, что было давно

омг

Документацию можно вести в разных инструментах

в вики

Можно в вики, можно в сваггере, можно в питонячих докстрингах

Можно и в комментариях

Поэтому я и призывал рассматривать задачу, а не средство её решения.

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

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

#QA_question
Помогите новичку советом, пожалуйста!
В общем, делаю сейчас это ТЗ для Яндекса с колдунщиком переводчика онлайн.
И хотела у вас спросить, какие тест-кейсы можно к нему написать. Я сделала пока 15 штук, один из которых чуток сомнительный, потому что не знаю, как правильно шаги к нему описать, но не суть.
Кнопочки там все проверила, перевод с одного языка на другой, неправильные символы, цифры, отображение иероглифов, а больше ничего в голову не лезет, хех.
Можете подсказать, какие еще можно кейсы написать?
Заранее огромное вам спасибо! (:

Если ТЗ - тестовое задание, то я бы новичку помог предложением не идти туда (в яндекс) горбатиться :)

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

Поможет определить, понятны ли кейсы только автору, или доступны для других

Не то, чтобы помощь, но напоминание.
У яндекс в полноценном переводчик есть функция, она предлагает вариант написания слова, если допущена опечатка. Её тоже бы проверить

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

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

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

К сожалению, писать надо только по этому колдунщику.

Так что функционал полного переводчика отпадает.

Убедилась, что такого в колдунщике нет?