Верхний пост

Привет. Вы находитесь в блоге технического писателя. В блоге размещаются:

  • статьи об инструментах, которые помогают техническим писателям в их работе;
  • инструкции и мануалы по использованию данных инструментов;
  • обзоры и описания сделанных мной проектов;
  • описание сложных вещей простыми словами (ну это я так думаю, что простыми);
  • подсказки и полезности.

Если хотите предложить мне интересный проект, заходите на страницу «Сотрудничество» или пишите через форму обратной связи. В настоящий момент мне интереснее всего организация баз знаний и работа над API документациями.

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

Почему система управления документами необходима для вашей организации

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

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

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

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

Читать далее «Управление документами»

Правила оформления списков (перечней)

В статье пойдет речь о том, как оформлять списки и перечни. Какие требования предъявляются с точки зрения пунктуации, удобства восприятия и общего юзабилити.

Читать далее «Правила оформления списков (перечней)»

Как ошибаются редакторы

В этой статье речь пойдет о сложных моментах в написании текстов. Как правильно писать «также » или «так же»; «при чем» или «причем»; «одеть» или «надеть»; «не совсем» или «не со всем» и многие другие вопросы, которые часто ставят в тупик.

Кроме того, в статье приводится ряд рекомендаций по тому, как создавать хорошие тексты.

Читать далее «Как ошибаются редакторы»

Правила пунктуации в русском языке

Русский язык один из самых сложных в мире. Огромное количество правил и исключений приводит к тому, что овладеть языком на хорошем уровне сложно не только иностранцам, но и коренным жителям России.

При написании и редактирования текстов часто требуется освежить в памяти правила русского языка. Чтобы каждый раз не обращаться к Гуглу или Яндексу, я собрал в своем блоге самые важные правила. А начать я хочу с правил пунктуации в русском языке.

Читать далее «Правила пунктуации в русском языке»

Уроки по работе с Microsoft Visio. Пятое занятие

Это завершающий урок, в нем рассматривается:

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

Читать далее «Уроки по работе с Microsoft Visio. Пятое занятие»

Уроки по работе с Microsoft Visio. Четвертое занятие

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

Временная диаграмма

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

Читать далее «Уроки по работе с Microsoft Visio. Четвертое занятие»

Уроки по работе с Microsoft Visio. Третье занятие

В этом уроке рассказывается о построении простых (нисходящая схема, схема отслеживания данных, схема планирования процессов и др.) и функциональных блок-схем (отображение отношений между бизнес-процессом и подразделениями).

Простая блок-схема

Шаблон Простая блок-схема предназначен для разработки блок-схем, нисходящих схем, схем отслеживания данных, схем планирования процессов и схем структурного прогноза. Шаблон содержит необходимые фигуры, соединительные линии и ссылки.

Читать далее «Уроки по работе с Microsoft Visio. Третье занятие»

Уроки по работе с Microsoft Visio. Второе занятие

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

Стандартные фигуры

Самый простой способ создания фигуры — ее перенос из набора фигур на схему. Основные категории наборов фигур, устанавливаемые по умолчанию при инсталляции Visio, можно увидеть, если щелкнуть кнопку Дополнительные фигуры в окне Фигуры.

Читать далее «Уроки по работе с Microsoft Visio. Второе занятие»

Уроки по работе с Microsoft Visio. Первое занятие

Общие сведения о приложении Microsoft Visio 2010

Microsoft Visio 2010 — это приложение для создания диаграмм и схем, помогающее визуализировать, исследовать и распространять сложные данные. В Microsoft Visio сложные для понимания таблицы и текст можно преобразовать в наглядные доступные схемы.

Приложение Microsoft Visio содержит современные фигуры и шаблоны для создания самых разнообразных схем в таких областях, как управление ИТ-средой, моделирование процессов, строительство и архитектурное проектирование, разработка пользовательского интерфейса, управление кадрами, проектами и т. д.

Создание документации в Wiki. Полезные плагины

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

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

Читать далее «Создание документации в Wiki. Полезные плагины»