Size: a a a

technicalwriters

2021 January 20

ME

Maria Ermakovich in technicalwriters
AVDR
джунский вопрос: пайтон для техписа — полезный инструмент (если рассматривать только языки программирования) или есть что-то, что больше поможет в наших праведных трудах?
учи пуфон, это к тому же и отличный первый язык чтобы познакомиться с концепциями типа массивов и циклов
источник

AY

Andrei Yemelianov in technicalwriters
Stas Rychkov
Крайне полезный. Благодаря большому количеству библиотек анализа текста. А в случае с Confluence — незаменимый. Ибо сам Confluence — это как писать код в Блокноте. Неплохая инфраструктура, но слабый набор базовых инструментов. Здесь-то и спасает Python.
PowerShell конечно проще ещё, но там плохо с библиотеками, придётся изобретать велосипед.
чем PowerShell проще, Стас?
источник

AY

Andrei Yemelianov in technicalwriters
мне тут по долгу службы приходится с ним работать иногда - впечатления самые плохие
источник

AY

Andrei Yemelianov in technicalwriters
Andrei Yemelianov
мне тут по долгу службы приходится с ним работать иногда - впечатления самые плохие
это я про PowerShell
источник

S

Sirius in technicalwriters
источник

S

Sirius in technicalwriters
Всем привет, а не подскажите как обычно форматируется табличка на описание элементов из массива?
В данном случае хочется как-то вправо сместить. Но если сместишь, то нарушится второй столбик.
источник

S

Sirius in technicalwriters
может кому-то попался пример красивый, в закладке сохранил

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

NV

Nick Volynkin in technicalwriters
Sirius
Всем привет, а не подскажите как обычно форматируется табличка на описание элементов из массива?
В данном случае хочется как-то вправо сместить. Но если сместишь, то нарушится второй столбик.
Это JSON?
источник

SR

Stas Rychkov in technicalwriters
Andrei Yemelianov
чем PowerShell проще, Стас?
Поставщиками типов и конвейерами.
источник

S

Sirius in technicalwriters
Nick Volynkin
Это JSON?
JS. Но JSON на нем основывается
источник

S

Sirius in technicalwriters
смотрю тут https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/Function/apply вообще без таблиц
вот тут не расписали https://devdocs.drift.com/docs/data-types-in-drift

это не апи документация, это внутри статьи есть просто пример кода и расшифровка параметров.
но вот смотрю еще апи документации, мне визуально часть с array не очень заметна
https://docs.solus.io/api/#operation/create-user
https://sendgrid.com/docs/api-reference/
https://mailchimp.com/developer/marketing/api/campaigns/cancel-campaign/
источник

SR

Stas Rychkov in technicalwriters
Nick Volynkin
А как ты используешь Python для работы в Confluence? Звучит очень интересно )
В разном --- по-разному. В основном --- утилитарно. Например, для отслеживания комментариев приходится писать скрипт. Для чистки пространств от лишних файлов --- тоже скрипт.

В Confluence проблема с мусором. Если кто-то зашёл на страницу, схватил мышью рисунок на странице и случайно отпустил кнопку... он загрузит копию рисунка на страницу. Конечно, для этого у посетителя должен быть доступ на изменение страниц, но мы стараемся держать Confluence на основах вики. Allow all. Что в корпоративной среде, где используются политика deny all, не всегда удобно.
источник

S

Sirius in technicalwriters
Sirius
источник

S

Sirius in technicalwriters
Хочется сместить вправо, как тут.

Но на этом примере нет общего след столбца
источник

AD

Alyona Devon in technicalwriters
у кого-то есть пример тз на статью базы знаний?
то когда я говорю что у меня задачи никогда не расписываются что там должно быть, кто-то не поверил. но почему-то примеры не дали

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

https://monosnap.com/file/QjEaUF1Yix7fI9BfsNeNh77QCwZeln
источник

K

Katy in technicalwriters
#wanted_tw
Ищу второго техписа в команду (я - первый).
В основном мы поддерживаем документацию всех продуктов Aurea Unlimited и GFI. Объем зависит от продукта - от редких релиз ноутов до регулярных обновлений с новыми фичами. Периодически портфель расширяется - тогда приемка и импорт документации. Работа в основном в MadCap Flare и OxygenXML в зависимости от проекта.

Условия работы: удаленно, 40 активных рабочих часов в неделю (перерывы не учитываются). 15$ час, часовой пояс значения не имеет; отпуск, больничный не оплачивается. Компания: Crossover.com
Требования: английский Upper Intermediate, прохождение теста CCAT не ниже 35. Очень желателен опыт работы техническим писателем и опыт работы - новички не справляются.  

Если интересно, пишите мне.
С уважением, Екатерина
источник

rK

rJIynbIu` KOT in technicalwriters
Alyona Devon
у кого-то есть пример тз на статью базы знаний?
то когда я говорю что у меня задачи никогда не расписываются что там должно быть, кто-то не поверил. но почему-то примеры не дали

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

https://monosnap.com/file/QjEaUF1Yix7fI9BfsNeNh77QCwZeln
я бы такую задачу просто переслал своему руководителю, а он такой дотошный и правильный, что поднял бы всех на уши вплоть до директора, что в таком виде приходит задача, что не пойми что делать и в каком виде. Ну может быть сначала написал бы инициатору, чтобы или в задаче расписал всё нормально, или пусть рассказывает словами, если уж настолько лень писать.
источник

IS

Igor Shakhbazyan in technicalwriters
Боже, это редмайн? сто лет его не видел.
источник

AD

Alyona Devon in technicalwriters
rJIynbIu` KOT
я бы такую задачу просто переслал своему руководителю, а он такой дотошный и правильный, что поднял бы всех на уши вплоть до директора, что в таком виде приходит задача, что не пойми что делать и в каком виде. Ну может быть сначала написал бы инициатору, чтобы или в задаче расписал всё нормально, или пусть рассказывает словами, если уж настолько лень писать.
это и есть задача от руководителя..
я надеялась что  менеджер по продукту хоть поресечит и тогда напишет

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

далеко не все элементы нужны всем сайтам, как и не все настройки

ну то такое, я еще подумаю над структурой и темами.

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

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

rK

rJIynbIu` KOT in technicalwriters
Alyona Devon
это и есть задача от руководителя..
я надеялась что  менеджер по продукту хоть поресечит и тогда напишет

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

далеко не все элементы нужны всем сайтам, как и не все настройки

ну то такое, я еще подумаю над структурой и темами.

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

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