Найти в Дзене

7 важных правил технического писателя

1. В документе не должно быть ничего лишнего, только по делу и по теме.

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

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

4. Технический писатель должен иметь широкий кругозор в той сфере, в которой пишет документы.

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

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

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