Рубрика: dokuwiki

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

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

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

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

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

Кликнув на эту ссылку мы попадем на пустую страницу, со следующим сообщением: «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-документация.
• Zendesk.
• Naturaldoc.
• Confluence.

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

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