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

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

1. Пишите документацию простым (понятным) языком

Пожалуй, это является основой, на которой строятся все последующие правила. 
Под языком здесь понимается стиль написания. Язык должен быть чётким, кратким, организованным. Это не значит, что нужно опускаться совсем до примитивизма. Важно правильно подобрать стиль изложения, исходя из уровня и потребностей целевой аудитории.

2. Пишите документацию для целевой аудитории, а не для себя

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

3. Подавайте материал “от общего к частному”

Перед тем, как перейти к деталям и подробностям, ознакомьте читателя с основными моментами, общим описанием.

4. Ограничивайте абзацы одной идеей и делайте их короткими

Для повышения удобочитаемости и лучшего понимания документации разбивайте материал на небольшие абзацы. В каждом абзаце сконцентрируйте читателя на одной мысли (идее).

5. Избегайте длинных предложений

Как можно чаще используйте короткие предложения взамен длинных. Это также повысит удобочитаемостях и понимание текста.

6. Используйте повседневные слова

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

7. Опускайте ненужные слова

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

8. Используйте повелительное наклонение

При описании пошаговых действий применяйте глаголы только повелительном наклонении (множественном числе).

9. Уделяйте большое внимание оформлению документации

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

10. Проверяйте сделанную работу

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

Казалось бы всё просто.

Тем не менее, встречается много случаев, когда эти простые правила (заповеди) не выполняются.