Технический писатель (англ. technical writer, technical author) — специалист, занимающийся документированием в рамках решения технических задач, в частности разработки программного обеспечения. wiki
Отсюда следует основное отличие технического писателя от обычного писателя - он умеет лаконично и ёмко выражать свои мысли. При написание технической документации, будь то техническое задание, комментарии в коде, таск в системе постановки задач или документация к проекту умеет не описывать очевидные вещи, а отвечать на вопросы:
- Что это такое?
- Зачем это было сделано?
- Почему так, а не иначе?
- Где искать дополнительную информацию?
Технический текст, в отличие от художественной литературы, должен ответить на все возможные вопросы читающего, из-за этого его написание должно быть построено принципу "вопрос/ответ":
/**
* Метод получения записи из базы данных
*/
public function getByIdFromDb(){
/**
* Метод записи в обход кэша, не используйте его под нагрузкой
*/
public function getByIdFromDb(){
- Боретcя с многогранностью русского языка
- Формулирует сухой и понятный текст к не очевидным частям системы
- Способен переформулировать текст из продуктовой задачи в техническое задание
- При написание документации продумывает те компоненты которые описаны и выявляет нестыковки
- Формулирует задачи таким образом, что их не придется пояснять устно
- Поддерживает в актуальном состояние документацию по крупным проектам