#выпуск 21

Всем привет! Когда мы тонем в рутине, хочется найти способ ускорить свою работу. Поэтому предлагаем обсудить:

Как писать документацию быстрее

1️⃣ Пишите для себя в будущем

Казалось бы, на первом месте должны стоять генерация или автоматизация, но мы предлагаем отталкиваться от лайфхака по поиску цели. Если вам сложно определить целевую аудиторию, пишите для себя: представьте, что вам через год или больше придется снова вернуться к этой теме. Какую бы вы информацию оставили самому себе? Это позволит вам понять, что и как писать, и как лучше составить промпт, если вы используете генерацию.

2️⃣ Используйте шаблоны

Разработайте шаблоны, подходящие именно для вашей документации. С ними вы сможете писать быстрее, преодолевая проблему чистого листа, а ваши читатели — искать нужную информацию в определённых разделах или блоках. Чтобы ускорить создание шаблонов, используйте ИИ, но обязательно проверьте сгенерированные тексты и схемы.

3️⃣ Ускорьте создание текста

В инструкциях используйте пирамиду Минто: изложите сначала главную мысль или цель, для чего нужны последующие действия, а затем излагайте их. Такой метод подходит для большинства типов документации. Придерживайтесь его, и вы потратите гораздо меньше времени на раздумья. А для написания текста настройте инструменты ускоренного ввода, например сниппеты для VS Code, и используйте горячие клавиши.

4️⃣ Автоматизируйте всё, что можно автоматизировать

Изучите, как генерировать документацию API из openapi-спецификации или release notes из коммитов в гите. Настройте нейрогенерацию текста из исходников, собранных "автоматом". Обязательно проверяйте результат генерации. Да, этот пункт не простой. Взвесьте все за и против, прежде чем браться за него. (Мы взялись не за всё)

5️⃣ Настройте проверки

Используйте спеллчекеры для проверки текста на ошибки и опечатки. Просматривайте логи, если используете генераторы сайтов. Это поможет исправить ошибки сразу и не тратить время на хотфиксы.

А как вы ускоряете создание документации?

#вопросвлоб

Всем привет! В рубрике "Вопрос в лоб" мы обычно разбираем частые вопросы на собеседованиях, но на этот раз поговорим немного о другом, не отходя от темы.

Как изменился наём техписателей за последние годы?

Сразу оговоримся, что здесь мы обобщаем собственный опыт и не говорим о найме ГОСТ-техписателей, поскольку его не ведём. Если у вас есть информация об этом сегменте рынка труда, поделитесь, пожалуйста, в комментариях.

📌 Легко вкатиться в IT — всё

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

📌 Техписатель — известная сущность

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

📌 Без джунов

Компании ищут не специалиста, а решение проблем. Поэтому чаще нужны самостоятельные единицы, которые готовы предложить своё решение, внедрить новые процессы. А это грейд middle и выше. Место джунов чаще всего замещают стажёры: они дешевле обходятся компании, и после стажировки работодатель получает самостоятельных junior plus или pre-middle, которые стоят дешевле обычных мидлов со стороны и уже могут приносить пользу бизнесу.

📌 Управленческие скиллы

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

📌 Смещение компетенций

Общий тренд на пресловутый ИИ привёл к изменению ландшафта компетенций (ух, как мы завернули!). Сейчас мало писать текст, важно уметь использовать все доступные инструменты для достижения цели.

А какие вы наблюдаете изменения?