Как написать документ - Советы и рекомендации

2012, June 13
Станислав
Начало статьи: Как написать документ

Достаточно, чтобы слова выражали смысл.

Конфуций

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

 

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

 

Если в тексте будут встречаться предложения, которые, несмотря на все ваши усилия, никак не могут написаться "красиво", то либо оставьте их в каком-нибудь более или менее приемлемом виде, либо все перепишите совсем иначе (возможно, целый абзац или даже несколько). Не пытайтесь написать "красиво" то, что никак не получается "красиво" написать - обычно это пустая трата времени.

 

Не пишите сложных и витиеватых предложений. "Предложения должны быть короткими как мысль пролетариата": Мир! Труд! Май!

 

Не нужно красивых и эффектных формулировок, это не художественная литература - "достаточно, чтобы слова выражали смысл".

 

Не нужно подражать юристам, и писать много сложных предложений с одинаковой описательной частью. Например:

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

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

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

 

Обращаю ваше внимание на то, как важно подбирать корректные слова. Для примера рассмотрим слова: "должен", "может", "способен", "следует" (фрагмент статьи Русский язык и Культура).

Должен - указывает на обязанность, на отсутствие выбора: "вы должны заплатить налоги, это ваш долг".

Может - указывает на вероятность или на разрешение: "может (возможно) вы напишете лучше" или "Он может (ему разрешено) марать бумагу сколько угодно". Слово "может" следует применять аккуратно: оно очень часто приводит к двусмысленности.

Способен - указывает на умение делать что-либо: "он способен (умеет) водить машину". Но если сказать "он может водить машину", то из фразы не ясно он умеет или ему разрешено.

Следует - указывает на необходимость сделать что-либо. Слово несет рекомендательный характер, и не исключает альтернативный выбор: "вам следует запомнить назначение этих слов". Но не совсем правильно сказать "вы должны запомнить назначение этих слов". Кому должны? О каком долге идет речь? Слова "следует" и "способен" почти утрачены, хотя без них большинство фраз становятся двусмысленными.

Рекомендовать "Как написать документ - Советы и рекомендации"