Привет! Спасибо за комментарий! Ага, этот стайлгайд мы делали маленькой группкой, гордимся им и хотим поделиться с другими! Не знаю насчет вас, но пока я ресерчила для нашего гайда, я видела не так уж много русскоязычных гайдов для технической доки — в основном для текстов интерфейсов. Так что рады пополнить число техписерских гайдов нашим!
А что касается табов, списков и прочего — вопросы языка и оформления текста бывают иногда очень комплексными и сложными, и каждая компания оформляет доку по-своему. Поэтому все эти сотни стайлгайдов и руководств, о которых вы говорите, на самом деле такие разные)
К тому же я, как техпис, знаю, что всегда интересно заглянуть, как там в этой компании доку пишут и как хинты оформляют, так что поддерживать доку — это не подвиг, а вот стайлгайд на всеобщее обозрение опубликовать — ещё какой! Надеюсь, другие команды, которые работают над своим гайдом или думают об этом, добавят наш в закладочки к сотням остальных стайлгайдов, и вдохновятся им 🙌🏻
Спасибо за комментарий! Рада, что вы нашли эту статью полезной! Отвечаю на вопросы по порядку:
При первом трудоустройстве техписом помогло наличие лингвистического образования — в проект нужен был человек со знанием английского. Остальное — везение, потому что я пришла совсем без опыта, но с желанием учиться 🙌🏻
Это банально, но смотрите на требования, которые компании постят у себя в вакансиях, и пытайтесь им соответствовать. Но даже если не соответствуете на 100%, не отчаивайтесь и все равно пробуйте — много компаний готовы брать новичков и обучать их, тот же Ozon :) Проектов, где требуются техписы, очень много, и они разнообразны — где-то нужен человек с хорошим английским, где-то — с сильным техническим бэкграундом. Узнайте ваши сильные стороны и продавайте их на собесах!
Да! У нас есть несколько крутых специалистов в команде техписов, которые когда-то приходили стажёрами. Заходите на https://job.ozon.ru/ и мониторьте — сейчас как раз открыта вакансия технического писателя :)
Интересно! Специально пошла искать по Справке для продавцов и покупателей, но нашла только один кейс, вот здесь, в раскрывашке «Что делать, если ваш магазин на Ozon заблокировали?», только это просто перечисление одного вопроса на разных языках. Вряд ли у нас будет много подобных примеров, потому что мы в документации редко используем вопросительные формулировки. Если же и пишем статьи в формате FAQ, то вопросы в них оформляем не списком, а в виде заголовков. Так что если вдруг наткнётесь в нашей Справке на такой кейс — приносите, интересно будет поглядеть!
Спасибо большое! Да, теперь можно избежать долгих споров о том, правильно писать именно в нашей доке, а можно просто дать ссылку на нужный раздел и сказать: вот по нашему гайду пишется так, извольте соблюдать, пожалуйста 😬
Привет! Так как наш стайлгайд живет сравнительно недавно, пока что были только кейсы, когда его дополняли новыми пойнтами или правили мелкие опечатки. Думаю, обязательно будут такие моменты, когда новички предложат пересмотреть какие-то разделы и отдельные пойнты. В таком случае, скорее всего, мы пойдем по нашему обычному пути — обсудим это на общем созвоне и зафиксируем в гайде, если потребуется. Считаю, что наоборот круто, если это произойдет, потому что это показывает, что наша дока живет и развивается)
Привет! Спасибо за комментарий! Ширина контента задаётся темой нашей Справки, тут с нашей техписательской стороны мало что можно сделать, но я передам фидбэк разработке!
Привет, спасибо за комментарий! Мы как раз в стайлгайде описали, в каких кейсах какой инструмент используется, например где использовать разноцветные плашки, табы или болд) И это в первую очередь внутренний инструмент и набор правил от техписов Ozon для техписов Ozon (и техписов других компаний, которые могут им вдохновиться, конечно!)
Про UI-код не очень поняла вопрос, получится ли перефразировать?
И да, стайлгайд мы действительно готовили довольно долго, больше полугода, и выкраивали для него время среди большого потока задач. Но для этого достаточно было пары заряженных сотрудников, которым нравилось этот стайлгайд писать)
Привет! Спасибо за комментарий! Ага, этот стайлгайд мы делали маленькой группкой, гордимся им и хотим поделиться с другими! Не знаю насчет вас, но пока я ресерчила для нашего гайда, я видела не так уж много русскоязычных гайдов для технической доки — в основном для текстов интерфейсов. Так что рады пополнить число техписерских гайдов нашим!
А что касается табов, списков и прочего — вопросы языка и оформления текста бывают иногда очень комплексными и сложными, и каждая компания оформляет доку по-своему. Поэтому все эти сотни стайлгайдов и руководств, о которых вы говорите, на самом деле такие разные)
К тому же я, как техпис, знаю, что всегда интересно заглянуть, как там в этой компании доку пишут и как хинты оформляют, так что поддерживать доку — это не подвиг, а вот стайлгайд на всеобщее обозрение опубликовать — ещё какой! Надеюсь, другие команды, которые работают над своим гайдом или думают об этом, добавят наш в закладочки к сотням остальных стайлгайдов, и вдохновятся им 🙌🏻
Спасибо за комментарий! Рада, что вы нашли эту статью полезной! Отвечаю на вопросы по порядку:
При первом трудоустройстве техписом помогло наличие лингвистического образования — в проект нужен был человек со знанием английского. Остальное — везение, потому что я пришла совсем без опыта, но с желанием учиться 🙌🏻
Это банально, но смотрите на требования, которые компании постят у себя в вакансиях, и пытайтесь им соответствовать. Но даже если не соответствуете на 100%, не отчаивайтесь и все равно пробуйте — много компаний готовы брать новичков и обучать их, тот же Ozon :) Проектов, где требуются техписы, очень много, и они разнообразны — где-то нужен человек с хорошим английским, где-то — с сильным техническим бэкграундом. Узнайте ваши сильные стороны и продавайте их на собесах!
Да! У нас есть несколько крутых специалистов в команде техписов, которые когда-то приходили стажёрами. Заходите на https://job.ozon.ru/ и мониторьте — сейчас как раз открыта вакансия технического писателя :)
Интересно! Специально пошла искать по Справке для продавцов и покупателей, но нашла только один кейс, вот здесь, в раскрывашке «Что делать, если ваш магазин на Ozon заблокировали?», только это просто перечисление одного вопроса на разных языках. Вряд ли у нас будет много подобных примеров, потому что мы в документации редко используем вопросительные формулировки. Если же и пишем статьи в формате FAQ, то вопросы в них оформляем не списком, а в виде заголовков. Так что если вдруг наткнётесь в нашей Справке на такой кейс — приносите, интересно будет поглядеть!
Спасибо большое! Да, теперь можно избежать долгих споров о том, правильно писать именно в нашей доке, а можно просто дать ссылку на нужный раздел и сказать: вот по нашему гайду пишется так, извольте соблюдать, пожалуйста 😬
Привет! Так как наш стайлгайд живет сравнительно недавно, пока что были только кейсы, когда его дополняли новыми пойнтами или правили мелкие опечатки. Думаю, обязательно будут такие моменты, когда новички предложат пересмотреть какие-то разделы и отдельные пойнты. В таком случае, скорее всего, мы пойдем по нашему обычному пути — обсудим это на общем созвоне и зафиксируем в гайде, если потребуется. Считаю, что наоборот круто, если это произойдет, потому что это показывает, что наша дока живет и развивается)
Привет! Спасибо за комментарий! Ширина контента задаётся темой нашей Справки, тут с нашей техписательской стороны мало что можно сделать, но я передам фидбэк разработке!
И правда, спасибо, что приложили!
Большое спасибо!
Привет, спасибо за комментарий! Мы как раз в стайлгайде описали, в каких кейсах какой инструмент используется, например где использовать разноцветные плашки, табы или болд) И это в первую очередь внутренний инструмент и набор правил от техписов Ozon для техписов Ozon (и техписов других компаний, которые могут им вдохновиться, конечно!)
Про UI-код не очень поняла вопрос, получится ли перефразировать?
И да, стайлгайд мы действительно готовили довольно долго, больше полугода, и выкраивали для него время среди большого потока задач. Но для этого достаточно было пары заряженных сотрудников, которым нравилось этот стайлгайд писать)