Документация от Samsung

Некоторое время назад я купил ноутбук фирмы Samsung из серии ATIV 5. Мне нужен был инструмент, который включает в себя плюсы ультрабуков и обычных ноутов. Более подробно процесс выбора я опишу в отдельной публикации, а этот пост — крик души о той инструкции, которую я нашел внутри Samsung NP530U4E.

Читать далее «Документация от Samsung»

Направления работ

Со мной можно сотрудничать по следующим направлениям:

  • Разработка технической документации.
  • Написание инструкций.
  • Создание мануалов и хелпов.
  • Проектирование веб-интерфейсов и экранов мобильных приложений.
  • Написание технических заданий.

Читать далее «Направления работ»

Создание документации в DokuWiki. Синтаксис (часть 2)

Создание новой страницы

dokuwiki-1Для того чтобы создать новую страницу достаточно разместить на неё ссылку (какие бывают ссылки смотрите ниже) в виде: [[Название статьи]]. Эта ссылка будет иметь пунктирное подчеркивание, как и любая другая ссылка в вики, ведущая на несуществующую страницу: ssilka

Кликнув на эту ссылку мы попадем на пустую страницу, со следующим сообщением: «This topic does not exist yet. You’ve followed a link to a topic that doesn’t exist yet. If permissions allow, you may create it by clicking on “Create this page”.»

Читать далее «Создание документации в DokuWiki. Синтаксис (часть 2)»

Создание документации в Wiki (часть 1)

Создание технической документацииЭтой статьей я начинаю серию публикаций, посвященных инструментам создания и ведения документации. Весь набор инструментов можно условно разделить на два типа: онлайн и оффлайн инструменты. К первому типу относятся сервисы, размещенные на вашем или стороннем сервере. Такая документация удобна тем, что создается и редактируется она удаленно и доступна сразу после сохранения всем пользователям. Примерами таких инструментов могут служить:

  • Wiki-документация.
  • Zendesk.
  • Naturaldoc.
  • Confluence.

Ко второму типу относятся программы и редакторы, устанавливаемые на компьютер техническому писателю. В результате их использования получается документ в одном из распространенных форматов: doc, pdf, chm и т.п. Для создания документации используются как классические редакторы вроде «MS Word», так и специализированные, например «Doc-o-Matic».

Здесь речь пойдет о создании документации в Wiki, а именно в её подвиде «DokuWiki». Читать далее «Создание документации в Wiki (часть 1)»

Как встраивать плагины и скрипты в блог на WordPress

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

Читать далее «Как встраивать плагины и скрипты в блог на WordPress»

Верхний пост

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

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

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