Технический писатель — профессия многогранная. Тут нужно не только уметь писать, разбираться в предмете, но еще и много общаться, чтобы добыть необходимую информацию. Иногда именно эта часть работы оказывается самой кропотливой.
Несколько советов о том, как найти подход к разработчику, от авторов уже знакомой книги "Technical writing 101":
- Учитывайте график разработчика. Звоните и приходите в удобное время. Если разработчик предпочитает общаться по почте, пишите письма (даже если сидите в одной комнате).
- Не задавайте вопросы по одному. Накапливайте и отправляйте списком.
- Научитесь читать код и извлекать из него информацию.
- Не задавайте глупых вопросов — сначала попытайтесь найти ответ самостоятельно.
- Облегчите жизнь разработчику: вставляйте ваши вопросы в текст документа крупным жирным шрифтом.
- Оставаясь вечером на работе, поделитесь пиццей!
- Организуйте вычитку таким образом, чтобы каждый разработчик вычитывал свою часть документа.
- Кексы. Много кексов!
- Посещайте регулярные встречи проекта, чтобы быть в курсе происходящего.
- Если ничего не помогает, выходите за него замуж! (Хотя, и это вряд ли поможет.)
На самом деле, в книжке опубликован список из 29 пунктов, я привожу сокращенную версию.
Интересно, а как по вашему опыту — что помогает лучше всего? Предлагаю поделиться собственными наблюдениями и историями.