Въпреки че често се игнорират от много компютърни потребители, помощните файлове предоставят ключова информация за това как да използват софтуерното приложение, с което са свързани. Чрез натискане на „Помощ“потребителят може да получи общ преглед на функциите на програмата, описание на екрана, който гледа или гледа, инструкции как да използва програмата за изпълнение на дадена задача или да прочете списъци с често задавани въпроси за програма и техните отговори. Писането на помощен файл изисква както способността за работа със софтуерни приложения, така и способността да се обясняват нещата по начин, който потребителите могат да разберат.
Стъпки
Стъпка 1. Вземете копие от софтуера, който трябва да документирате
Ако е възможно, трябва да получите и копие от писмените спецификации за програмата, въпреки че не всички разработчици на софтуер работят с тях. В някои случаи програмистът ще се отклони от спецификациите въз основа на краткото време за разработка или неспособността да кодира определена функция.
Стъпка 2. Получете инструмент за създаване на помощ
Въпреки че е възможно ръчно да се създаде помощен файл, като се използва файл с богат текст (.rtf), повечето автори на помощни файлове използват софтуерно приложение, за да напишат своите помощни файлове, като RoboHelp, Help и Manual, Doc-To -Помощ, MadCap Flare или HelpLogix. Повечето инструменти за създаване на помощ включват текстов редактор или работа с програма за текстообработка като Microsoft Word и предоставят потребителски интерфейс, който позволява на автора за помощ да види как ще изглежда помощният файл, докато го пише, докато пише компютърния код зад кулисите за да работи помощният файл. Някои инструменти за създаване на помощ включват също графични редактори за създаване на екранни снимки, които да се включат в помощния файл.
Има няколко формата на помощни файлове: Най -често срещаният е HTML Help, който се използва от приложения, работещи в Windows. (По -старият формат, WinHelp, вече не се поддържа.) Apple и Unix също имат свои собствени формати, както и Sun Microsystems с JavaHelp. Софтуерните приложения, предназначени да работят под няколко операционни системи, могат да използват кросплатформена помощна система, която работи в уеб браузъра на потребителя. Който и инструмент за създаване на помощ, който използвате, трябва да поддържа помощния формат (и), в който ще създавате помощни файлове
Стъпка 3. Създайте файла за помощния проект
Вашият инструмент за създаване на помощ ще създаде файл за помощния проект за вас въз основа на предоставеното от вас име на файла и друга информация. Основният файл на проекта съдържа информация за другите файлове, които включват файл със съдържание, индексен файл, един или повече файлове с изображения и други файлове.
- Файлът със съдържание включва текста в помощния файл, който обяснява как работи софтуерното приложение, което документирате. Текстът обикновено се разделя на теми, които покриват определен екран, функция или процедура.
- Индексният файл е списък с темите на помощния файл. Използва се за създаване на съдържание, което потребителите могат да използват, за да изберат тема за преглед, както и индекс за търсене в помощния файл.
- Графичните файлове са графични файлове на екранни програми или части от тези екрани, показани в помощния файл, за да се подобри способността на потребителите да разберат за какво се отнася текстът на помощния файл.
Стъпка 4. Регулирайте размера на прозореца за помощ
Освен ако не пишете помощния файл, който да се появи в уеб браузъра на потребителя, помощният файл ще се появи в неговия собствен прозорец. Вашият инструмент за създаване на помощ ще ви позволи да регулирате хоризонталните и вертикалните размери на прозореца до размер, който ще позволи на крайния потребител да прочете помощния файл, без да пречи на самото приложение. Основният прозорец за помощ често е във формат с три панела, със съдържанието вляво и избраната тема вдясно.
Помощните файлове могат също да имат, в допълнение към основния прозорец, вторични прозорци, които описват подробно определена функция и автоматично оразмеряват изскачащи прозорци, които дават кратко описание на функциите. Помощните файлове също могат да включват вграден текст, който се появява само когато е маркиран текст или бутон
Стъпка 5. Напишете помощните теми
За да направите това, ще трябва да прегледате спецификациите или самата програма, за да създадете теми, които да документират екраните и функциите на програмата. Когато създавате всяка тема, вашият инструмент за създаване на помощ ще я добави към съдържанието и индекса на помощния файл.
- Въпреки че можете да изграждате съдържанието, докато вървите, помага да имате някакъв план за това как да го организирате. Можете да организирате съдържанието около екраните на програмата, нейните функции, начини за използване или някаква комбинация от тях.
- Докато пишете темите, помислете за друга информация в помощния файл, до която потребителите ще искат да имат бърз достъп. Можете да създавате скокове или хипервръзки в текста на помощния файл, който се свързва с темите, които имат тази информация.
Стъпка 6. Включете екранни снимки, ако е необходимо
Много функции на програмата се обясняват най -добре с комбинация от текст и графики. Можете да създавате екранни снимки или с приложението, което се предлага с помощта на вашия инструмент за създаване, или с отделно приложение, като Microsoft Paint, Paint Shop Pro или SnagIt.
- Текстът и екранните снимки трябва да бъдат подредени заедно в тема, така че потребителите да могат да видят екранната снимка и поддържащия я текст без ненужно превъртане. В много случаи ще искате да покажете част от екрана на програмата вместо целия екран или да покажете екранната снимка в по -малък размер от оригинала. Вашето приложение за екранна снимка трябва да може да променя размера на екранната снимка без замъгляване или загуба на детайли.
- Ако очаквате промени в потребителския интерфейс между тестовата и последната версия на програмата, може да искате да спрете създаването на екранни снимки, докато имате окончателната версия на програмата, с която да работите.
Стъпка 7. Създайте файл с карта, ако е необходим
Някои програми включват бутони „Помощ“, за да може потребителят да кликне и да покаже темата в помощния файл, който конкретно описва как работи този екран. Показването на тема по този начин се нарича контекстно-зависима помощ и изисква създаване на файл с карта, за да може програмистът да свърже бутона „Помощ“с конкретната тема във вашия помощен файл. Вашият инструмент за създаване на помощ може да създаде такъв за вас или програмистът може да го кодира и да ви го даде, за да го включите в помощния файл.
Стъпка 8. Компилирайте помощния файл
Компилирането създава действителния помощен файл, който ще бъде включен в програмата. За повечето помощни формати това ще включва всички компонентни файлове, създадени при създаването на помощния файл, въпреки че някои некомпилирани помощни формати също изискват отделните файлове с теми за помощ да бъдат включени в програмата.
Стъпка 9. Тествайте помощния файл
След като компилирате помощния файл, трябва да го тествате, за да се уверите, че всички хипервръзки се свързват с темите, които би трябвало, и всички графики се показват правилно. Помощният файл също трябва да бъде тестван, за да се гарантира, че съдържанието е точно и подходящо за потребителите и в последователен формат. Ще искате сами да прегледате помощния файл и хората, които тестват приложението, също да го прегледат.
При по -големи проекти за помощни файлове компилирането и тестването са текущи процеси. Ще искате да компилирате помощния файл и да проверите работата си няколко пъти, преди да създадете окончателната версия
Стъпка 10. Дайте помощния файл на разработчика, който да включи в програмата
В зависимост от характера на проекта и формата на помощния файл, може да се наложи да предоставите на разработчика няколко файла, включително файл с карта, ако има контекстно-чувствителни теми.
