Правила создания хороших текстовых документов

Вы умеете делать текстовые документы, в которых легко ориентироваться и которые легко понимать? Нюансов здесь много, ловите основные принципы, сохраняйте, соблюдайте, повышайте уровень культуры документирования нашей страны :)

Принцип 1. Структурируй документ:

• Делай титульный лист и содержание, если в документе более 10 листов.
• Разделяй текст на абзацы по смыслу. Абзацы следует объединять также по смыслу в подразделы, подразделы - в разделы.
• Выноси справочные материалы большого объема в приложения.
• Располагай приложения в конце документа в том же порядке, в котором они в первый раз упоминались в документе.

Принцип 2. Используй нумерацию и перечни:

• Пронумеруй все разделы и подразделы, если документ большой.
• Включай в нумерацию подразделов номер родительского раздела (например, раздел 1, подразделы 1.1, 1.2 и т.д.).
• Начинай каждый новый раздел с нового листа.
• Используй нумерованные списки в тексте, если важна последовательность в перечне.
• Используй маркированные списки в тексте, если последовательность в перечне не важна.
• Не забывай про нумерацию страниц.

Принцип 3. Сделай текст понятным и читаемым:

• Расшифровывай все сокращения и аббревиатуры. Если их много, сделай в документе раздел с расшифровкой всех сокращений и аббревиатур, который встречаются в документе. В этом разделе сокращения лучше расположить по алфавиту.
• Сделай одинаковым шрифтом весь основной текст документа. Самый легко-читаемый размер 12пт.
• Сделай межстрочный интервал больше 1пт: я всегда ставлю 1,15пт.
• Не используй в документе иностранные слова, если есть приемлемый аналог в русском языке. Например, "back up" или "бэк ап" лучше заменить на "резервная копия".

#документы #правила