Если вы пишете документация в markdown или в confuence, вам повезло. Если вы же вы используете MS Word, то могут начаться сложности с единообразием документации. Под катом - способы по приходу к единому формату.
Если взять и посмотреть заголовки, оформление таблиц и главное блоки кода, то легко можно заметить что каждый делает как хочет. Что довольно странно, учитывая навязанную политику крупных компаний ставить определенную подпись к письмам, к дресс коду и прочему. Но есть простой способ договориться к однообразию.
Так как у нас нет такого единого формата, я решил делать для себя. А так как некоторое время назад я занимался вебом, то я не смог долго смотреть на "Заголовок 1" и переименовал его на "H1". С остальными заголовками - аналогично.
Если у вас был стиль "Обычный", то при выборе текста этого же формата, можно выбрать как русские слова, так и английский и spellchecker их корректно отображает. Но была замечена особенность, что если на основе "Обычного" создать стиль для контента в таблицах "u_t", и на основе него создать стиль для заголовков в таблицах "u_t_h1", то заголовок будет только в одном языке. Т.е. если пишите на английском и у вам русский "краснеет" или наоробот. Готовых решений в сети не нашлось, экспериментальным образом получилось найти следующее: все новые стили создавать только на основе базовых.
Если взять и посмотреть заголовки, оформление таблиц и главное блоки кода, то легко можно заметить что каждый делает как хочет. Что довольно странно, учитывая навязанную политику крупных компаний ставить определенную подпись к письмам, к дресс коду и прочему. Но есть простой способ договориться к однообразию.
Стили
Для начала стоит собрать единый (может только для одного подразделения) шаблон. Благо MS позаботилась о своих пользователях и разрешила всегда по умолчанию подключать normal.dotm. Он находится в каталоге%userprifile%\AppData\Roaming\Microsoft\Templates\практически на всех версиях windows. Можно раз создать образцовый документ с оформлением которое всех устраивает, назвать стили и скопировать в этот шаблон.
Так как у нас нет такого единого формата, я решил делать для себя. А так как некоторое время назад я занимался вебом, то я не смог долго смотреть на "Заголовок 1" и переименовал его на "H1". С остальными заголовками - аналогично.
Правописание
Но особую боль вызывают стили созданные на основе другого стиля, если у вас используется "Правописание". По какой то непонятной логике работает наследование основного языка.Если у вас был стиль "Обычный", то при выборе текста этого же формата, можно выбрать как русские слова, так и английский и spellchecker их корректно отображает. Но была замечена особенность, что если на основе "Обычного" создать стиль для контента в таблицах "u_t", и на основе него создать стиль для заголовков в таблицах "u_t_h1", то заголовок будет только в одном языке. Т.е. если пишите на английском и у вам русский "краснеет" или наоробот. Готовых решений в сети не нашлось, экспериментальным образом получилось найти следующее: все новые стили создавать только на основе базовых.
Макеты
Что говорить таблицы любят все и они просто не заменимы при описании структуры БД. Другое дело, что лениво каждый раз настраивать отображение таблиц. Но по аналогии со стилями заголовков можно создать стиль для таблицы, поставить его по умолчанию или вообще отправить в меню быстрого доступа.
Таблицы
По роду деятельности надо часто отписывать объекты БД. Исходя из опыта, стоит на уровень рефлексов перевести следующие шаги:
1) Резервировать как минимум 4 столбца для описания одной строки: имя, размерность с типом", комментарий (для записи в БД), источник данных. Последний пункт можно конечно объединить с предпоследним, но люди часто забывают об этой договоренности, а такой формат будет как живое напоминание.
2) Всегда включать перенос заголовков на другую страницу. Если у вас здоровая таблица для хранения параметров какого либо объекта, то уже через пол страницы вчитывания вы просто забываете как у вас названы заголовки.
3) Всегда указывать источник данных: будь то идентификатор из какой либо другой таблицы, кой-либо справочник, ну или на худой конец - decode (применимо для oracle запросов)
Рецензирование
Почти везде корпоративным стандартом является в начале документа заполнять историю изменения. Правда это не всегда помогает, если несколько авторов изменили документ не внеся свои ФИО в параметры MS Office. Не поверите, это невероятно раздражает, когда авторов документа было 3, все изменения сделал Windows User, а вам для исправления бага надо отследить кто когда и зачем сделал определенные изменения в логике.
Ладно, вы внесли свои данные в среду, правите документ не отключая рецензирования... Но включите голову, зачем в истории хранить не только изменения текста а изменения форматирования? Все правки по форматированию можно в 2 клика "принять" если включить только их отображения и "принять отображаемые изменения". Довольно простой трюк, который избавит ваших коллег от просмотра бесконечного количества ненужной информации.
Макросы
Да, я как никто другой знаю, какое это зло. Я делал массовую дистрибуцию "анализатора" для первички в одном банке и если скомпилировать надстройку не в той версии ничего не будет работать. Но тем не менее, это удобно.
Помните, в начале мы договорились хранить стили в шаблоне, а шаблон класть в дефолтную директорию. В этом же шаблоне можно хранить макросы для доступности из любого документа. К примеру там у меня есть PrepForSpell для исправления языка выделенного слова.
Импорт и экспорт
Для того что бы в меню стилей добавить сохраненные ранее шаблоны в normal.dotm или наоборот нужно откопать меню по экспорту, что весьма не тривиально, если заранее не знаешь где. Для word 2013 сценарий следующий:
Меню → Дизайн → Пользовательские интервалы для абзаца (самое нижнее меню) → Импорт/Экспорт (нижний левый угол).
Ну и пример моего олдскульного стиля: https://www.dropbox.com/s/6on8md8xq47irkl/OldSchool.dotm
Ну и пример моего олдскульного стиля: https://www.dropbox.com/s/6on8md8xq47irkl/OldSchool.dotm
