Size: a a a

technicalwriters

2021 February 28

ME

Maria Ermakovich in technicalwriters
Mila
Привет! Ребят, подскажите, пожалуйста, что должно быть в хорошей документации по фиче? Чтобы разработчикам и дизайнерам показать и на её основе создать таски? Также кто-то сталкивался с тем, чтобы KPI ставить (как мы поймём, что фича successful)?
источник

ME

Maria Ermakovich in technicalwriters
чеклист для любой документаци, не только апи
источник

M

Mila in technicalwriters
Спасибо, посмотрю 🙏
источник
2021 March 01

ВП

Вячеслав Пантелеев... in technicalwriters
Привет! Я один из фрилансеров c команды нaшегo телеграм кaналa пo заpаботкy)
На нем мы беcплaтно дeлимcя провepенными спocобaми того, как без нaпpяга делaть дeньги в ceти
Заходи к нaм и yже завтpа полyчaй первую выплaтy нa карту:
👉 https://t.me/joinchat/6_-GBqqOVA81YjI6
источник

NV

Nick Volynkin in technicalwriters
1500 участников чата. Ура, поздравляю нас. :)
источник

Н

Николай in technicalwriters
👏👏👏
источник

МК

Марина Ковалева... in technicalwriters
Mila
Привет! Ребят, подскажите, пожалуйста, что должно быть в хорошей документации по фиче? Чтобы разработчикам и дизайнерам показать и на её основе создать таски? Также кто-то сталкивался с тем, чтобы KPI ставить (как мы поймём, что фича successful)?
фича=функциональность... как надо описать ее? - как и другие функциональности
в рамках какого компонента АС, для каких ролей, показатели назначения, требования к функциям, требования к видам обеспечения, перспективы развития, сценарии использования... как вы поняли, в основе будут лежать требования из ТЗ/ОПЗ
источник

МК

Марина Ковалева... in technicalwriters
таски можно разбить по функциям отдельным, у тасков есть своя статусная модель - после анализа и прочих согласований, пока все таски по функциям не перейдут на статус Реализовано, общий таск на всю фичу будет в неготовом статусе, а КПИ по подтаскам определять
куда катится мир, такое не для техписов
источник

СФ

Семён Факторович... in technicalwriters
#wanted_tw #tw_wanted #hr_lynch

Мы (documentat.io) ищем себе опытного ГОСТ-техписателя (3+ лет опыта).

Фронт работ — разработка комплектов документов по ГОСТ 19 и ГОСТ 34 для разных заказчиков, государственных и частных.

Это фултайм-позиция с трудоустройством: не разовая проектная деятельность, не парт-тайм, а постоянная полная загрузка.

Работа полностью удаленная, часовой пояс не важен.

80-100к.

Откликайтесь на hh (https://hh.ru/vacancy/42644496) или сразу присылайте резюме на job@documentat.io.

Всем кандидатам будет предложено тестовое задание.
источник
2021 March 02

MC

Milkhail Che in technicalwriters
источник

M

M2 in technicalwriters
Добр утро коллеги.
вопрос, согласно ГОСТ 34.602-89 (да, я вляпался в туда), есть требование

"Общие положения
1.7. Изменения к ТЗ на АС оформляют дополнением или подписанным заказчиком и разработчиком протоколом. Дополнение или указанный протокол являются неотъемлемой частью ТЗ на АС. На титульном листе ТЗ на АС должна быть запись «Действует с … »."

я правильно понимаю - что "«Действует с … »" это не для добавления даты (с которой начинается действие толи ТЗ толи чегото там еще),
а делается именно так:  слово "Действует" и "прочерк" - на котором можно вписать некое название другого документа - дополнения?
например об этом вроде явно "написано в гугле" : На любом этапе работы при согласии заказчика и исполнителя в ТЗ могут быть внесены изменения и дополнения, которые оформляются дополнительным соглашением к договору. В этом случае на титульном (первом) листе ТЗ делается запись «Действует с дополнительным соглашением № ».

возник спор прошу рассудить - там
Действует с "дата действия"
или
Действует с дополнительным соглашением № __
источник

СФ

Семён Факторович... in technicalwriters
неожиданно крутой артефакт технической коммуникации: отчет ВОЗ о ликвидации черной оспы, 1980 год https://apps.who.int/iris/bitstream/handle/10665/197790/WHA33_3_rus.pdf?sequence=1&isAllowed=y
источник

СФ

Семён Факторович... in technicalwriters
всё восхитительно: оформление (когда вы в последний раз читали машинописные документы?), стиль, язык, структура, да и само содержимое читается как остросюжетный роман
источник

СФ

Семён Факторович... in technicalwriters
strong Fallout vibes
источник

BF

Bobba Fett in technicalwriters
источник

IS

Igor Shakhbazyan in technicalwriters
Вряд ли таблицы и картинки на машинке набирали, без этих их компьютеров точно не обошлось, уверен) но оформлено шикарно, согласен, особенно впечатляет труд, который пришлось вложить на технике и ПО 40-летней давности для достижения такого результата.
источник

IS

Igor Shakhbazyan in technicalwriters
И ещё фраза "имеет честь с настоящим препроводить", чувствуешь себя благороднее как-то)
источник

МК

Марина Ковалева... in technicalwriters
Коллеги, кто работает в финтехе.
У вас для каких-то функций используется ИИ (искуственный интеллект)? Что это за функции?
источник

AY

Andrei Yemelianov in technicalwriters
Написал в чат DocOps, но на всякий случай спрошу и здесь. Ситуация такая:  есть исходник документа в формате Markdown.  Из этого исходника c помощью pandoc собирается документ в PDF и HTML. При этом в тексте есть абзацы, которые должны попадать только в HTML-версию, а в PDF — не должны.  Как сделать, чтобы часть текста попадала в собранный документ только при соблюдении определённых условий (например, чтобы именно этот конкретный абзац попадал именно в PDF, а в HTML не попадал)?
Решал ли кто-нибудь такую задачу? И если решали, то как? поделитесь опытом
источник

ET

Eduard Tibet in technicalwriters
Andrei Yemelianov
Написал в чат DocOps, но на всякий случай спрошу и здесь. Ситуация такая:  есть исходник документа в формате Markdown.  Из этого исходника c помощью pandoc собирается документ в PDF и HTML. При этом в тексте есть абзацы, которые должны попадать только в HTML-версию, а в PDF — не должны.  Как сделать, чтобы часть текста попадала в собранный документ только при соблюдении определённых условий (например, чтобы именно этот конкретный абзац попадал именно в PDF, а в HTML не попадал)?
Решал ли кто-нибудь такую задачу? И если решали, то как? поделитесь опытом
Здесь требуется утоянение: решалась ли подобная задача с помощью Markdown c использованием именно приведенного в посте инструментария? Или решалась ли в принципе?
источник