DokuWiki

It's better when it's simple

Инструменты пользователя

Инструменты сайта


ru:faq:documentation

Чем «Докувики» хороша для документирования?

  • Легко установить.
  • Легко начать работу: можно публиковать ещё незаконченные материалы.
  • Простое и целостное расположение страниц.
  • Легко создавать и обновлять документы:
    • возможна коллективная работа;
    • авторизованный или анонимный доступ через веб;
    • для работы не нужно знать HTML;
    • легко устанавливать связи между страницами;
    • простой поиск;
    • расширяемость и возможность наполнения материалами с внешних ресурсов.

И это ещё не всё

  • Простое редактирование:
    • редактирование страницы по секциям.
  • Автоматически:
    • помечаются красным ссылки на ещё несуществующие страницы;
    • генерируется список всех страниц, ссылающихся на текущую;
    • производится внутреняя индексация для полнотекстового поиска;
    • сохраняется истории изменений страницы.
  • Несколько способов выделения кода, примеров и прочих элементов документации.
  • Страницы хранятся на сервере в обычных текстовых файлах, поэтому:
    • они могут быть прочитаны, даже если сервер находится в нерабочем состоянии;
    • легко организовать резервное копирование, так же как файлы на обычной файловой системе;
    • могут быть легко прочитаны, изменены, сравнены, сгенерированы с помощью внешних (не-вики) программ;
  • Маленькие и приятные «фишки», делающие документацию лучше: сноски, расшифровка абрревиатур на лету, подсветка синтаксиса кода;
  • Большое количество плагинов;
  • Много чего ещё, всё и не вспомнишь ;-)
ru/faq/documentation.txt · Последнее изменение: 2015-04-25 10:39 — Aleksandr

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki