Size: a a a

2020 February 11

FM

Fox Mulder in technicalwriters
Еще раз про HUGO! Он обманчив прост. Если брать только тему и не модифицировать её, то да, hugo зайдет.
Но! Вот далее, потребуется не просто начальные, а прямо так advanced скиллы в css+js+toml+yaml+html.
Многие вещи не решаются вот просто так, а требуют глубокого погружения в фронтенд. Ну или отдать кастомизацию фронту, но не всегда это возможно.
источник

NV

Nick Volynkin in technicalwriters
Fox Mulder
Еще раз про HUGO! Он обманчив прост. Если брать только тему и не модифицировать её, то да, hugo зайдет.
Но! Вот далее, потребуется не просто начальные, а прямо так advanced скиллы в css+js+toml+yaml+html.
Многие вещи не решаются вот просто так, а требуют глубокого погружения в фронтенд. Ну или отдать кастомизацию фронту, но не всегда это возможно.
Станислав, если ты хочешь кастомизировать тему или написать свою, то конечно же тебе понадобятся хоть базовые навыки. Но опять же, готовых тем полно, курсов по фронтенду тоже полно )
источник

EN

Ekaterina Noskova in technicalwriters
Fox Mulder
Еще раз про HUGO! Он обманчив прост. Если брать только тему и не модифицировать её, то да, hugo зайдет.
Но! Вот далее, потребуется не просто начальные, а прямо так advanced скиллы в css+js+toml+yaml+html.
Многие вещи не решаются вот просто так, а требуют глубокого погружения в фронтенд. Ну или отдать кастомизацию фронту, но не всегда это возможно.
ну ты не пугай ежа голой жопой, у нас и так кастомная тема и фронтендеров найдем если что. просто хотелось бы с минимальным количеством усилий запустить
источник

SR

Stas Rychkov in technicalwriters
Fox Mulder
Еще раз про HUGO! Он обманчив прост. Если брать только тему и не модифицировать её, то да, hugo зайдет.
Но! Вот далее, потребуется не просто начальные, а прямо так advanced скиллы в css+js+toml+yaml+html.
Многие вещи не решаются вот просто так, а требуют глубокого погружения в фронтенд. Ну или отдать кастомизацию фронту, но не всегда это возможно.
Кто прост и без обмана?
источник

SR

Stas Rychkov in technicalwriters
Elena Parameshwari L24[Mg7]
Ребята и девчата, привет! Хочется с вами посоветоваться. У нас разработчики ведут новый проект, и встроенную документацию (ака описание встроенного языка) решили "писать сами". Сейчас они хранят это дело, как мне показали, в Confluence, в виде каталогов и файлов формата md. А меня на днях "попросили вычитать". Но меня волнует такой аспект: предполагается работа с этими markdown-файлами "просто через git", и есть подозрение, что если оставить все в текущей организации, с развитием этого встроенного языка, я рискую потерять "контроль" над тем, что происходит. Хотелось бы спросить у тех, кто работает с mardown, как вы организуете хранение файлов, как можно, например, "хотя бы оценить объем текста", как отслеживаете изменения этого текста (например, если документы и их изменения для следующих версий планируется отдавать на перевод)? Пока мне не кажется управляемой куча папок и файлов, которую мне хотят "просто выгрузить из confluence". И это немного напрягает...
MD наверное лучше хранить в git'е, а в Confluence лишь публиковать результат. Благо Confluence сам преобразует MD во внутреннюю разметку.

https://marketplace.atlassian.com/apps/1211675/git-for-confluence

https://community.atlassian.com/t5/Confluence-questions/How-to-import-hundreds-of-md-files/qaq-p/725975
источник

FM

Fox Mulder in technicalwriters
Stas Rychkov
Кто прост и без обмана?
Если честно, претензия у меня серьезная только одна - их сайт с докой падает постоянно.
источник

EP

Elena Parameshwari L24[Mg7] in technicalwriters
я и говорю, у меня больше возникло вопросов по управлению всем этим потенциальным git-хозяйством. Вот предположим несколько веток в git - каждая ветка будет для отдельной версии одного продукта, вот как отслеживать какой файл в одной ветке соответствует (описывает один и тот же объект) файлу описания другой ветки? Как можно оперативно отслеживать изменения (допустим разрабы внесли, как в этом ворохе можно быстро увидеть, что они внесли - что фактически требует правка). и немаловажно - что из этого всего "было переведено, а что только требует перевода".
источник

EP

Elena Parameshwari L24[Mg7] in technicalwriters
тут напрашивается, еще какие-то внешние инструменты для управления содержимым этого самого гита
источник

SR

Stas Rychkov in technicalwriters
Fox Mulder
Если честно, претензия у меня серьезная только одна - их сайт с докой падает постоянно.
Хе! Неприятно, но Cloudflare поможет им.
источник

ТС

Татьяна Серая in technicalwriters
#wanted_tw #техническийписатель #technicalwriter #relocate #Кипр
Всем привет! Мы продолжаем искать в нашу продуктовую команду на Кипре Технического писателя.
Мы международная хостинговая компания, оперируем на протяжении 10 лет на рынках США, Западной и Восточной Европы и Азии. ​Мы строим полностью автоматизированную платформу, способную удовлетворять разнообразным требованиям наших клиентов.

Чем предстоит заниматься:
- создание и поддержание в актуальном состоянии базы знаний по продуктам и технологиям на английском языке;
- текстовое и схематическое описание сложных технических решений;
- организация и активное участие в процессе разработки документации продуктов.

Требования:
- опыт работы в качестве технического писателя от 1 года;
- грамотная устная и письменная речь, умение кратко выражать свои (и чужие) мысли;
- технический английский;
- умение работать с Atlassian Confluence и JIRA;
- высшее образование (желательно, техническое).

Будет плюсом:
- опыт работы в хостинговых компаниях;
- понимание принципов работы сетей;
- опыт в области разработки ПО;
- знание UML (и желание его использовать).

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

Присоединяйтесь к нашей команде! Буду благодарна за резюме tatyana@servers.com
источник

SR

Stas Rychkov in technicalwriters
Elena Parameshwari L24[Mg7]
тут напрашивается, еще какие-то внешние инструменты для управления содержимым этого самого гита
Вы имеете в виду Atlassian SourceTree?
https://www.sourcetreeapp.com/
источник

SR

Stas Rychkov in technicalwriters
Татьяна Серая
#wanted_tw #техническийписатель #technicalwriter #relocate #Кипр
Всем привет! Мы продолжаем искать в нашу продуктовую команду на Кипре Технического писателя.
Мы международная хостинговая компания, оперируем на протяжении 10 лет на рынках США, Западной и Восточной Европы и Азии. ​Мы строим полностью автоматизированную платформу, способную удовлетворять разнообразным требованиям наших клиентов.

Чем предстоит заниматься:
- создание и поддержание в актуальном состоянии базы знаний по продуктам и технологиям на английском языке;
- текстовое и схематическое описание сложных технических решений;
- организация и активное участие в процессе разработки документации продуктов.

Требования:
- опыт работы в качестве технического писателя от 1 года;
- грамотная устная и письменная речь, умение кратко выражать свои (и чужие) мысли;
- технический английский;
- умение работать с Atlassian Confluence и JIRA;
- высшее образование (желательно, техническое).

Будет плюсом:
- опыт работы в хостинговых компаниях;
- понимание принципов работы сетей;
- опыт в области разработки ПО;
- знание UML (и желание его использовать).

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

Присоединяйтесь к нашей команде! Буду благодарна за резюме tatyana@servers.com
Добрый день. Татьяна, добавьте, пожалуйста, тэг, как указано в прикреплённом наверху сообщении. Спасибо.
источник

EP

Elena Parameshwari L24[Mg7] in technicalwriters
вот если честно. не уверена. у нас был настроен конкретный рабочий процесс с отслеживанием всех необходимых изменений. сейчас разрабы решили, что новый продукт они будут писать в по-другому (и формаТ, и хранение), но конкретных инструментов (под установленный процесс) пока не предлагали. что я от них слышала - это Git + Visual Studio Code. Но это не то, что я могу назвать инструментом для конкретной задачи в уже установленном процессе
источник

СХ

Саша Хо in technicalwriters
Elena Parameshwari L24[Mg7]
я и говорю, у меня больше возникло вопросов по управлению всем этим потенциальным git-хозяйством. Вот предположим несколько веток в git - каждая ветка будет для отдельной версии одного продукта, вот как отслеживать какой файл в одной ветке соответствует (описывает один и тот же объект) файлу описания другой ветки? Как можно оперативно отслеживать изменения (допустим разрабы внесли, как в этом ворохе можно быстро увидеть, что они внесли - что фактически требует правка). и немаловажно - что из этого всего "было переведено, а что только требует перевода".
У нас если что-то в каком-нибудь PR изменилось, на почту падает письмо. Так что мимо изменений особо не пройдёшь.
В рамках PR изменения отслеживаются по diff.
В том репозитории, где мы работаем совместно с программистами, нельзя мержить PR, пока техписатель не согласует правки, так что мимо нас всё равно не пройти.
С переводами да, может быть проблема.
источник

СХ

Саша Хо in technicalwriters
Проверку работоспособности ссылок вроде можно настроить (но это отдельный инструмент).
источник

SR

Stas Rychkov in technicalwriters
Elena Parameshwari L24[Mg7]
я и говорю, у меня больше возникло вопросов по управлению всем этим потенциальным git-хозяйством. Вот предположим несколько веток в git - каждая ветка будет для отдельной версии одного продукта, вот как отслеживать какой файл в одной ветке соответствует (описывает один и тот же объект) файлу описания другой ветки? Как можно оперативно отслеживать изменения (допустим разрабы внесли, как в этом ворохе можно быстро увидеть, что они внесли - что фактически требует правка). и немаловажно - что из этого всего "было переведено, а что только требует перевода".
Изменения вы будете видеть автоматом после checkout'а.

Или так: https://stackoverflow.com/questions/10641361/get-all-files-that-have-been-modified-in-git-branch/10641810

Попросите разработчиков показать вам основные приёмы работы с гитом.
источник

S

Sara in technicalwriters
Саша Хо
У нас если что-то в каком-нибудь PR изменилось, на почту падает письмо. Так что мимо изменений особо не пройдёшь.
В рамках PR изменения отслеживаются по diff.
В том репозитории, где мы работаем совместно с программистами, нельзя мержить PR, пока техписатель не согласует правки, так что мимо нас всё равно не пройти.
С переводами да, может быть проблема.
Если есть ресурсы, то можно в ci куда-нибудь засунуть типа скриптика, проверяющего изменения. Мы все хотим такой, но ресурса нет пока 😔
источник

SR

Stas Rychkov in technicalwriters
Elena Parameshwari L24[Mg7]
вот если честно. не уверена. у нас был настроен конкретный рабочий процесс с отслеживанием всех необходимых изменений. сейчас разрабы решили, что новый продукт они будут писать в по-другому (и формаТ, и хранение), но конкретных инструментов (под установленный процесс) пока не предлагали. что я от них слышала - это Git + Visual Studio Code. Но это не то, что я могу назвать инструментом для конкретной задачи в уже установленном процессе
Попросите разработчиков добавить уведомления, например через BitBucket.

https://confluence.atlassian.com/bitbucketserver/repository-notifications-949754838.html
источник

ME

Maria Ermakovich in technicalwriters
Elena Parameshwari L24[Mg7]
тут напрашивается, еще какие-то внешние инструменты для управления содержимым этого самого гита
Docusaurus :)
источник

EP

Elena Parameshwari L24[Mg7] in technicalwriters
интересно. Спасибо!
источник