Size: a a a

technicalwriters

2021 June 22

AK

Aleksandr K. in technicalwriters
Да, можно и так)
источник

BF

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

AK

Aleksandr K. in technicalwriters
О, не знал о том, что есть отбор на основании языка проекта. Спасибо
источник

О

Олеся in technicalwriters
#wanted_tw
Добрый день.
Я представляю АНО ДПО «Академия АйТи»

Ищем специалиста для сотрудничества в роли преподавателя по программе «Технический писатель».

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

Группы формируем небольшие поскольку не ориентируемся на физических лиц

Требование к преподавателю: опыт в проведении обучающих мероприятий, знание ГОСТ (в частности - особенности разработки ГОСТовой документации, ГОСТ 19, ГОСТ 34

Формат курса – чаще всего курсы проходят в формате вебинара

Количество часов (академических) – 16

Оплата руб/час – договорная

С преподавателем заключаем Договор ГПД.

Ссылка на курс: https://www.academyit.ru/courses/TW/

По всем вопросам обращаться:
@Olesya_Pakalevich
www.academyit.ru
Курсы
<p>
</p>
<div>
</div>
<p>
</p>
<p>

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


Особенностью данной профессии является то, что автор должен уметь создавать технические тексты разных стилей, сочетая в себе задатки «лирика» и «физика».


Пройдя обучение, слушатели получат знания, необходимые для работы с документацией, научатся писать тексты различных стилей на техническую тематику (технические статьи, технические задания, руководства пользователей, руководства по технической эксплуатации, формуляры и др.) на основе отечественных и зарубежных стандартов документирования, а также легко смогут применить приобретенные умения и навыки в реальных рабочих условиях.
</p>
<p>
</p><p>
</p>
<p>
</p>
<p align="left"> …
источник

OR

Olga Revyakina in technicalwriters
Как думаете, раздел "Часто задаваемые вопросы" должен идти в самом начале документации или в самом конце? С одной стороны, сначала нужно рассказать о продукте хоть что-то, а потом уже на вопросы отвечать. С другой стороны, для тех кто уже немного знаком с продуктом, не читает все подряд, а ищет именно ответ, в начале этот раздел скорее бросится в глаза.
источник

FM

Fox Mulder in technicalwriters
в другом разделе
источник

FM

Fox Mulder in technicalwriters
лендинг документации (сайта) должен явно разделять две сущности:  документация и faq
источник

FM

Fox Mulder in technicalwriters
правило хорошего тона для документации - индексация и поиск
источник

VI

Vladimir Izmalkov in technicalwriters
Зависит от формата документации и поставленных перед документацией целей.
Стандартно FAQ размещается на сайте, ссылка на видном месте, но не как часть разделов документации. Плюс важно еще чтобы страница FAQ индексировалась - так как большая вероятность переходов с поиска (если вопросы составлены правильно).
источник

OR

Olga Revyakina in technicalwriters
я хочу, чтобы они не искали FAQ поиском, а видели сразу.
источник

VI

Vladimir Izmalkov in technicalwriters
Опять же FAQ лендинга, для еще не купивших продукт потеницальных клиентов может отличаться от FAQ для клиентов, купивших продукт.
источник

BF

Bobba Fett in technicalwriters
Похоже на ответ на ваш вопрос
источник

FM

Fox Mulder in technicalwriters
так сделайте отдельную вкладку под faq
источник

OR

Olga Revyakina in technicalwriters
вкладка это в данном случае что? Есть раздел в документации - FAQ.
источник

OR

Olga Revyakina in technicalwriters
в данном случае - для уже купивших
источник

FM

Fox Mulder in technicalwriters
нельзя впихивать разный тип контента в одностраничный документ. Никто простыни читать не будет.
Задача техписа - помочь пользователю с продуктом.
FAQ - это сборник вопросов и ответов, которые помогут за минимально возможное время помочь пользователю.
источник

O[

Olga [olgademoscu] in technicalwriters
@revolg у вас документация в каком виде доходит до тех, кто её читает? Это сайт со статьями? Сайт со ссылками на документы для скачивания?
источник

O[

Olga [olgademoscu] in technicalwriters
☝️ вот да. Если вы читателям отдаете условно pdf, я бы FAQ сделала скорее отдельным файлом.
источник

OR

Olga Revyakina in technicalwriters
стандартно для веба - слева оглавление, справа читать ) Не pdf, веб-справка. Вопрос мой - куда в оглавлении поставить, в начало или в конец.
источник

FM

Fox Mulder in technicalwriters
Слева - это не эргономично. Вставляйте TOC справа. А вот </h1> идут слева, да.
Если у вас webhelp, то faq идёт в конце.
Если у вас сайт со справкой, то faq идёт вкладкой в верхнем меню.
источник