Программист, шалгагчийн техникийн баримт бичиг, дотоод хэрэглэгчдэд зориулсан техникийн баримт бичиг, эцсийн хэрэглэгчид зориулсан гарын авлага, тусламжийн файл гэх мэт сайн програм хангамжийн баримт бичиг нь програм хангамжийн онцлог, функцийг ойлгоход хэрэглэгчид туслах болно. Сайн баримт бичиг гэдэг нь хэрэглэгчид хэрэгтэй бүх мэдээллийг агуулсан тодорхой, ойлгомжтой, хамааралтай баримт бичиг юм. Энэхүү нийтлэл нь техникийн хэрэглэгчид болон эцсийн хэрэглэгчдэд зориулсан програм хангамжийн баримт бичгийг бичихэд тань туслах болно.
Алхам
2 -ийн 1 -р арга: Техникийн хэрэглэгчдэд зориулсан програм хангамжийн баримт бичгийг бичих
Алхам 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 хэлбэрээр зохион байгуулж болно. Заримдаа хоёр форматыг хослуулах нь маш сайн шийдэл юм.
- Лавлах форматыг товчлуур, таб, талбар, харилцах цонх гэх мэт програм хангамжийн бүх онцлог шинж чанар, хэрхэн ажилладаг талаар тайлбарлахад ашигладаг. Зарим тусламжийн файлууд энэ форматаар бичигдсэн байдаг, ялангуяа контекстэд мэдрэмтгий байдаг. Хэрэглэгч тодорхой дэлгэц дээр Help дээр дарахад хэрэглэгч холбогдох сэдвийг хүлээн авах болно.
- Гарын авлагын форматыг програм хангамжийн тусламжтайгаар хэрхэн яаж хийхийг тайлбарлахад ашигладаг. Гарын авлага нь ихэвчлэн хэвлэмэл эсвэл PDF форматтай байдаг боловч зарим тусламжийн хуудсуудад зарим зүйлийг хэрхэн хийх талаар зааварчилгаа орсон байдаг. (Ерөнхийдөө гарын авлагын формат нь контекстэд мэдрэмтгий биш боловч контекстэд хамааралтай сэдвүүдээс холбогдож болно). Гарын авлага нь ерөнхийдөө гарын авлага хэлбэрээр хийгдэх бөгөөд тайлбарлах даалгавруудын хураангуй, алхам алхмаар форматласан гарын авлага юм.
Алхам 4. Баримт бичгийн төрлийг шийдэх
Хэрэглэгчдэд зориулсан програм хангамжийн баримт бичгийг хэвлэсэн гарын авлага, PDF файлууд, тусламжийн файлууд эсвэл онлайн тусламж гэсэн дараах форматуудын аль нэг эсвэл хэд хэдэн хэлбэрээр багцалж болно. Баримт бичгийн төрөл бүр нь хөтөч эсвэл зааварчилгаа байхаас үл хамааран програм хангамжийн функцийг хэрхэн ашиглахыг харуулах зорилготой юм. Онлайн баримт бичиг, тусламжийн хуудсуудад жагсаал видео, текст, статик зураг оруулах боломжтой.
Онлайн тусламж, дэмжлэгийн файлуудыг индексжүүлж, түлхүүр үг ашиглан хайх боломжтой байх ёстой бөгөөд ингэснээр хэрэглэгчид хэрэгтэй мэдээллээ хурдан олох боломжтой болно. Туслах файл үүсгэгч програм нь индексийг автоматаар үүсгэж болох боловч түгээмэл хайлт хийдэг түлхүүр үгийг ашиглан гараар индекс үүсгэхийг зөвлөж байна
Алхам 5. Тохирох баримт бичгийн хэрэгслийг сонгоно уу
Хэвлэсэн гарын авлага эсвэл PDF файлыг урт, нарийн төвөгтэй байдлаас хамааран Word гэх мэт текст боловсруулах програм эсвэл FrameMaker гэх мэт дэвшилтэт текст засварлагч ашиглан үүсгэж болно. Тусламжийн файлуудыг RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix, HelpServer гэх мэт туслах файл үүсгэх програмын тусламжтайгаар бичиж болно.
Зөвлөмж
- Хөтөлбөрийн баримт бичгийн текстийг уншихад хялбар байхаар зохион бүтээсэн байх ёстой. Зургийг зохих тексттэй аль болох ойр байрлуул. Баримт бичгийг логикоор хэсэг, сэдвээр нь задлах. Хэсэг эсвэл сэдэв бүр нь даалгавар болон програмын онцлог шинж чанаруудын аль алиныг нь тодорхойлох ёстой. Холбогдох асуудлыг линк эсвэл лавлах жагсаалтаар тайлбарлаж болно.
- Энэ нийтлэлд тайлбарласан баримт бичгийн хэрэгслүүд тус бүрийг SnagIt гэх мэт дэлгэцийн зураг бүтээгч програмаар нэмж болно, хэрэв таны баримт бичигт олон дэлгэцийн агшин шаардлагатай бол. Бусад баримт бичгийн нэгэн адил та хэрэглэгчийг "уруу татах" бус харин апп хэрхэн ажилладаг талаар тайлбарлахын тулд дэлгэцийн агшинг оруулах ёстой.
- Загварт анхаарлаа хандуулах нь маш чухал бөгөөд ялангуяа хэрэв та эцсийн хэрэглэгчдэд зориулсан програм хангамжийн баримт бичгийг бичиж байгаа бол. Хэрэглэгчдэд "хэрэглэгчийн" оронд "та" гэсэн төлөөний үгээр хандаарай.
