вторник, 11 октября 2011 г.

Правила хорошего документа

Что отличает правильно написанный тех документ?
То же что и выступление хорошего политика - яркость, лаконичность, простота.

(рекомендую к прочтению - Карстен Бредемайер "Черная риторика", Альпина паблишер". 
Не менее 2/3 разговорных приемов можно и нужно использовать при подготовке документов)

Итак хороший документ должен быть:

1. Гармоничным. Хорошая и понятная структура изложения. Четкая рубрикация. Информация должна быть там "где ее ожидают".

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

3. Делайте "паузы" в документах. Разбивайте документ на разделы. Абзац не больше 10 строк. Раздел не больше 3-5-и страниц. Если в разделе должна быть большая спецификация, код, таблица - отправьте в приложение.

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

5. Фокусируйте внимание читателя  на основных положениях документа, не разбавляйте их пустопорожним описанием. Или следуйте п.4

6. Обязательно включайте в текст описание технических терминов которые вы используете.

7. Откажитесь от льстивых замечаний в адрес читателя. Особенно в различного рода обоснованиях и коммерческих предложениях.

8. Лучше меньше, да лучше. Обилие аргументов не нужно. Обилие доказательств не нужно. Обилие описаний и деталей не нужно. Не нужно и наличие нескольких вариантов работы.  

Комментариев нет:

Отправить комментарий