Программисттер менен сыноочулар үчүн спецификациялык документтер, ички колдонуучулар үчүн техникалык документтер же акыркы колдонуучулар үчүн колдонмолор жана жардам файлдары болобу, жакшы программалык документтер колдонуучуларга программалык камсыздоонун өзгөчөлүктөрүн жана функцияларын түшүнүүгө жардам берет. Жакшы документация - бул колдонуучуга керектүү болгон бардык маалыматтар менен конкреттүү, так жана актуалдуу документтер. Бул макала техникалык колдонуучулар жана акыркы колдонуучулар үчүн программалык документтерди жазууга жардам берет.
Кадам
Метод 1 2: Техникалык колдонуучулар үчүн программалык документтерди жазуу
Кадам 1. Кандай маалыматты киргизүүнү билиңиз
Спецификация документи интерфейс дизайнерлери, код жазуучу программисттер жана программалык камсыздоонун иштешин текшерүүчү тестирлөөчүлөр үчүн колдонмо катары колдонулат. Киргизилиши керек болгон маалымат түзүлүп жаткан программага жараша болот, бирок төмөнкүлөрдү камтышы мүмкүн:
- Колдонмодогу маанилүү файлдар, мисалы, иштеп чыгуу тобу түзгөн файлдар, программа иштеп жатканда жеткиликтүү болгон маалымат базалары жана үчүнчү жактын тиркемелери.
- Функциялар/подпрограммалар, анын ичинде функция/подпрограмманы, киргизүү жана чыгаруу баалуулуктарын колдонуу боюнча түшүндүрмө.
- Программанын өзгөрмөлөрү жана константалары, жана алар кантип колдонулат.
- Программанын жалпы структурасы. Дискке негизделген программалар үчүн, ар бир модулду жана китепкананы сүрөттөө керек болушу мүмкүн. Же, эгер сиз вебке негизделген программа үчүн колдонмо жазып жатсаңыз, анда ар бир барак кайсы файлдарды колдонорун түшүндүрүшүңүз керек болот.
Кадам 2. Документтердин кайсы деңгээлин программалык коддон ажыратуу керектигин чечиңиз
Программанын кодуна киргизилген техникалык документтер канчалык көп болсо, аны жаңыртуу жана тейлөө, ошондой эле программанын ар кандай версияларын түшүндүрүү оңой болот. Эң аз дегенде, программанын кодундагы документацияда функцияларды, кичи программаларды, өзгөрмөлөрдү жана константаларды колдонуу камтылышы керек.
- Эгерде баштапкы кодуңуз узун болсо, анда документти жардам файлына жаза аласыз, аны индекстөөгө же айрым ачкыч сөздөр менен издөөгө болот. Программанын логикасы бир нече беттерге бөлүнсө жана веб -тиркеме сыяктуу колдоо файлдарын камтыса, өзүнчө документ файлдары пайдалуу.
- Кээ бир программалоо тилдеринин (мисалы, Java, Visual Basic. NET, же C#) өзүнүн коддоо документтеринин стандарттары бар. Мындай учурларда, баштапкы кодго киргизилиши керек болгон стандарттык документтерди аткарыңыз.
Кадам 3. Тиешелүү документ инструментин тандаңыз
Кээ бир учурларда, документтештирүү куралы колдонулган программалоо тили менен аныкталат. C ++, C#, Visual Basic, Java, PHP жана башка тилдердин өздөрүнүн документтери бар. Бирок, андай болбосо, колдонулган куралдар керектүү документтерге көз каранды болот.
- Документтер кыска жана жөнөкөй болгондо, Microsoft Word сыяктуу текст процессору документтин текст файлдарын түзүүгө ылайыктуу. Татаал текст менен узун документтерди түзүү үчүн, көпчүлүк техникалык жазуучулар Adobe FrameMaker сыяктуу адистештирилген документтерди тандашат.
- Булак кодун документтештирүү үчүн жардам файлдары RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare же HelpLogix сыяктуу колдоо файл генератору программасы менен түзүлүшү мүмкүн.
Метод 2 2: Акыркы колдонуучулар үчүн программалык документтерди жазуу
Кадам 1. Колдонмону түзүүнүн негизи болгон бизнес себептерин билиңиз
Программалык документтердин негизги себеби колдонуучуларга тиркемени кантип колдонууну түшүнүүгө жардам берүү болгону менен, документтерди түзүүнүн башка бир нече себептери бар, мисалы, маркетинг бөлүмүнө тиркемени сатууга жардам берүү, компаниянын имиджин жакшыртуу жана техникалык колдоону азайтуу. чыгымдар. Кээ бир учурларда, документтер регламентке же башка мыйзамдык талаптарга ылайык келиши үчүн талап кылынат.
Бирок, документтер интерфейсти жакшы алмаштыра албайт. Эгерде тиркеме иштеши үчүн көп документтерди талап кылса, ал интуитивдүү түрдө иштелип чыгышы керек
Кадам 2. Документтердин максаттуу аудиториясын билүү
Жалпысынан алганда, программалык камсыздоонун колдонуучулары алар колдонгон тиркемелерден тышкары чектелген компьютердик билимге ээ. Алардын документтерге болгон муктаждыктарын канааттандыруунун бир нече жолу бар:
- Программаны колдонуучунун аталышына көңүл буруңуз. Мисалы, тутум администратору ар кандай компьютердик тиркемелерди жакшы түшүнөт, ал эми катчы маалыматтарды киргизүү үчүн колдонгон тиркемелерди гана билет.
- Программаны колдонуучуларга көңүл буруңуз. Алардын позициялары жалпысынан аткарылган тапшырмаларга шайкеш келгенине карабай, бул кызмат орундары иштин ордуна жараша ар кандай жүктөмгө ээ болушу мүмкүн. Потенциалдуу колдонуучулар менен маектешүү менен, алардын жумуш наамына берген бааңыз туура же туура эмес экенин биле аласыз.
- Учурдагы документтерге көңүл буруңуз. Программалык камсыздоонун документтери жана өзгөчөлүктөрү колдонуучулар аларды колдонуу үчүн эмнени билиши керек экенин көрсөтө алат. Бирок, колдонуучулар программанын "ички жактарын" билүүгө кызыкпашы мүмкүн экенин эстен чыгарбаңыз.
- Тапшырманы аткаруу үчүн эмне керек экенин жана аны аткаруудан мурун эмне керек экенин билиңиз.
Кадам 3. Документтер үчүн ылайыктуу форматты аныктаңыз
Программалык документтер 1 же 2 форматта, тактап айтканда маалымдама китептеринде жана колдонмолордо жайгаштырылышы мүмкүн. Кээде, эки форматты айкалыштыруу жакшы чечим болуп саналат.
- Шилтеме форматтары программалык камсыздоонун бардык функцияларын, мисалы, баскычтарды, өтмөктөрдү, талааларды жана диалог кутучаларын жана алардын кантип иштээрин сүрөттөө үчүн колдонулат. Айрым жардам файлдары бул форматта жазылган, өзгөчө контекстке сезимтал. Колдонуучу белгилүү бир экранда Жардамды басканда, колдонуучу тиешелүү теманы алат.
- Кол форматы программалык камсыздоо менен бир нерсени кантип жасоону түшүндүрүү үчүн колдонулат. Колдонмолор көбүнчө басма же PDF форматында болот, бирок кээ бир жардам баракчаларында кээ бир нерселерди кантип жасоо боюнча көрсөтмөлөр камтылган. (Жалпысынан алганда, кол форматтары контекстке сезимтал эмес, бирок контекстке тиешелүү темалардан шилтемелениши мүмкүн). Колдонмолор жалпысынан гид түрүндө, сүрөттөмөдө аткарылуучу милдеттердин кыскача баяндамасы жана этап менен форматталган жол көрсөткүч.
Кадам 4. Документтердин түрү боюнча чечим кабыл алыңыз
Колдонуучулар үчүн программалык документтер төмөнкү форматтардын биринде же бир нечесинде пакеттелиши мүмкүн: басылган окуу куралдары, PDF файлдары, жардам файлдары же онлайн жардам. Документтердин ар бир түрү программалык камсыздоонун функцияларын кантип колдонууну көрсөтүү үчүн иштелип чыккан, ал гид же окуу куралы болобу. Онлайн документтери жана жардам баракчалары демонстрациялык видеолорду, текстти жана статикалык сүрөттөрдү камтышы мүмкүн.
Онлайн жардам жана колдоо файлдары индекстелиши керек жана колдонуучулар керектүү маалыматты тез таба алышы үчүн ачкыч сөздөрдү колдонуп издөө керек. Жардам файл генераторунун колдонмосу индексти автоматтык түрдө түзө алса дагы, көбүнчө изделген ачкыч сөздөрдү колдонуп индексти түзүү сунушталат
Кадам 5. Тиешелүү документ инструментин тандаңыз
Басылып чыккан колдонмолор же PDF файлдын узундугуна жана татаалдыгына жараша Word же текст өңдөөчү FrameMaker сыяктуу программалар менен түзүлүшү мүмкүн. Жардам файлдары RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix же HelpServer сыяктуу жардам файлын түзүү программасы менен жазылышы мүмкүн.
Кеңештер
- Программалык документтердин тексти окууга оңой түзүлүшү керек. Сүрөттү мүмкүн болушунча тиешелүү текстке жакын жайгаштырыңыз. Документтерди логикалык жактан бөлүмдөр жана темалар боюнча бөлүңүз. Ар бир бөлүм же тема белгилүү бир көйгөйдү, милдетти да, программанын өзгөчөлүктөрүн да сүрөттөп бериши керек. Тиешелүү маселелерди шилтемелер же маалымдама тизмелери менен түшүндүрсө болот.
- Бул макалада сүрөттөлгөн ар бир документ инструменти SnagIt сыяктуу скриншот жаратуучу программасы менен толукталышы мүмкүн, эгер сиздин документтер бир нече скриншотту талап кылса. Башка документтер сыяктуу эле, колдонуучуну "азгыруунун" ордуна, колдонмонун иштешин түшүндүрүүгө жардам берүү үчүн скриншотторду да кошушуңуз керек.
- Стилге көңүл буруу абдан маанилүү, айрыкча сиз акыркы колдонуучулар үчүн программалык документтерди жазып жатсаңыз. Колдонуучуларга "колдонуучу" ордуна "сиз" ат атооч менен кайрылыңыз.
