Уики двигатели за публикуване на документация за потребителя
дисертации бяха накратко, както следва:
- Най-удобната форма на документация за потребителя - онлайн документация;
- Тази документация е удобно да се разпространява, контрол на достъпа, поддържа и развива, за да получите обратна връзка от потребителите;
- Има много функции и инструменти за поставяне на документи в Интернет и всеки може да избере по свой вкус и възможности;
- Най-традиционен инструмент - платформа уики (уики-двигатели), на който искам да ви кажа, в тази статия.
На уебинара и след получих въпроси, които на двигателя, за да изберете и какво да правя с него. Признавам, по това време аз не бях готов да препоръча нещо по-специално, изборът е много голям, и 1C-Заедно подобен начин за разпространение на документация за потребителя не се практикува в проектите.
След като учи повече уики-двигатели, представя на Вашето внимание преглед на DokuWiki - прост и мощен двигател, който е специално предназначен за онлайн документация.
DokuWiki - безплатен софтуер, разпределени по лиценз GPLv2, работи на всяка платформа, на която ще бъде в състояние да имат PHP. Отличителна черта на този двигател е, че в допълнение към PHP да работи, той не се нуждае от MySQL или PostgreSQL, т.е. То ще работи на почти всяка много евтин споделен хостинг.
Освен това силно зависи от това къде и как вие ще направите сайт с документация. Опитах се да го направя в под-домейн на сайта им на виртуален сървър, това е много проста. В хостинг контролен панел създаде уеб-домейн, не забравяйте да се отбележи, че имаме нужда от подкрепа за PHP. Хостинг създава празен директория за новия сайт, хвърля през панела за ZIP-файл с двигателя и даде команда, за да разопаковате. Това е цялата инсталация, отидете в настройките.
Отворете страницата с първоначалната настройка:
На първо място, за да превключите на разбираем език, точно в горната част има списък от възможности за избор Изберете вашия език и щракнете върху бутона Update.
Ляв идентифицира основните параметри на DokuWiki двигател:
Натиснете, за да запазите, изтрийте install.php файл от директорията домакин. Не забравяйте да прочетете съвети за безопасност от разработчиците и да ги направя.
Първоначалната настройка е завършена. Сега ние сме готови да започнем творческия процес, но ако не разполагате с опита на писане на уикито, трябва да се изяснят някои ключови точки.
Използвайте текст цветни стикери, с което, в основните им идеи и важни точки - това е един добър стил в Wiki. се вмъква стикер етикет
Вътре всички статии, подобни на обичайната структура на конвенционален документ, който създавате в Word. Използвайте заглавната H1 на 1-во ниво, за да се даде името на статията, H2, H3 и да продължи да се създаде структура на статията. Когато статията повече от 3 титли DokuWiki автоматично ще се създаде таблица на съдържанието в него.
DokuWiki структура, подобна на дърво на директории и файлове. Общият размер на съдържанието на документацията, наречени "Индекс" и се струват автоматично. Помислете върху структурата предварително, преди да бъде запълнена.
Напълнете документацията на уики, разбира се, по-добре да се разшири скрит или всички в локалната мрежа или за ограничаване на достъпа. В DokuWiki проста и мощна система за контрол на достъпа. Създаване на две групи за защита: @editors - тя добавя служители, които работят с документацията, задаване на разрешения за създаване и качване на файлове и @users (тя е създадена по подразбиране) - в него се добавят потребители, определени права за четене, или отворени за достъп за четене всички @ALL.
И ако трябва да конвертирате PDF в книга, че за тази цел има и друг полезен плъгин BookCreator. След инсталирането е необходимо да се направи специална статия страница, където книги ще бъдат изградени. Сочейки към сингъла таг
За да обобщим. DokuWiki - прост и мощен двигател достатъчно да се създаде онлайн конфигурации документация на 1C: Enterprise.
Предимствата включват:
Сред недостатъците трябва да се отбележи: