Зохион бүтээгч, программист, рационализатор хичнээн овсгоотой байсан ч заримдаа түүний бүтээлийг зориулалтын дагуу ашиглах боломжгүй байдаг. Үүний шалтгаан нь буруу боловсруулсан гарын авлага эсвэл бүрэн байхгүй байх явдал юм. Гэхдээ овсгоотой зохион бүтээгчид хүртэл заримдаа ийм нарийн зааварчилгаа бичдэг бөгөөд нарийн мэргэжилтнүүдээс гадна хэн ч эдгээр баримт бичгийг унших боломжгүй байдаг. Ийм шаардлагатай баримт бичгийг хэрхэн зөв бүрдүүлэх вэ?
Энэ нь зайлшгүй шаардлагатай
- - гарын авлага бичиж буй төхөөрөмж эсвэл програм хангамжийн бүтээгдэхүүний талаар зуун хувь мэдлэгтэй байх;
- - хэл шинжлэлийн мэдлэг;
- - бичих чадвар.
Зааварчилгаа
1-р алхам
Хэрэглэгчийн гарын авлага буюу өөрөөр хэлбэл ашиглалтын гарын авлага нь тодорхой системийг хэрэглэгчдэд ашиглахад туслах зорилгоор боловсруулсан баримт бичиг юм. Хэрэглэгчийн гарын авлагыг эмхэтгэхийн тулд та тодорхойлсон системийг зуун хувь мэддэг байх ёстой, гэхдээ мунхаг оюутны нүдээр хараарай. Хэрэглэгчийн гарын авлагыг одоогоор аналоггүй програм хангамжийн хэрэгсэлд зориулж бичсэн гэж үзье. Энэ програмыг анх удаа ашиглаж байгаа гэж төсөөлөөд үз дээ. Та хаанаас эхлэх вэ? Хамгийн түрүүнд юу мэдэх хэрэгтэй вэ? Энэхүү мэдлэгээ ач холбогдлын ангиллаар зохион байгуул.
Алхам 2
Бүтээлийнхээ талаархи бүх мэдээллийг бүлэгт хувааснаар та хэрэглэгчийн гарын авлага бичих төлөвлөгөө боловсруулсан болно. Програмынхаа ажлыг эхнээс нь тайлбарлаж эхлээрэй, дахин програмчлах эсвэл чухал алдаануудыг шийдвэрлэх гэх мэт хамгийн хэцүү нарийн зүйлийг үлдээгээрэй. Энэ үе шатанд та хэрэглэгчийн гарын авлагын агуулгыг бэлэн байлгах ёстой - энэ баримт бичгийн шаардлагатай хэсгүүдийн нэг.
Алхам 3
Хэрэв таны бүтээж буй гарын авлага нь том компанид ашиглахаар төлөвлөж байгаа бол тэнд батлагдсан корпорацийн стандартыг анхаарч үзэх хэрэгтэй. Жишээлбэл, Оросын олон компаниудад хэрэглэгчийн гарын авлагыг зураг чимэглэлгүйгээр, өөрөөр хэлбэл бичсэн зүйлийг тайлбарласан зураггүйгээр хүлээн авахгүй. Ашиглалтын гарын авлагад агуулгаас гадна заавал дагаж мөрдөх ёстой бусад хэсгүүд орсон байх ёстой: - Тэмдэглэгээ, өөрөөр хэлбэл гарын авлагын ерөнхий зорилго, тайлбарласан бүтээгдэхүүний тайлбар; - хэрэглэгчийн гарын авлагатай холбоотой баримт бичгүүдийг тайлбарласан танилцуулга гарын авлагыг ашиглах; - бүтээгдэхүүний ашиглалтын янз бүрийн үе шатанд бүтээгдэхүүний ашиглалтыг тайлбарласан хэсгүүд, жишээлбэл, эхний алхам, засвар, засвар үйлчилгээ; - байнга асуудаг асуулт, түүнд хариулах хэсэг; - тайлбар толь бичиг эсвэл сэдэвчилсэн индекс.
Алхам 4
Ихэвчлэн техникийн зохиолч нь хэрэглэгчийн гарын авлагыг бий болгоход оролцдог бөгөөд энэ нь хэл дээр болон тайлбарласан бүтээгдэхүүний хувьд шаардлагатай бүх мэдлэгийг эзэмшдэг хүн юм. Сургалтгүй техникийн зохиолчийн хувьд цөөн хэдэн дүрмийг анхаарч үзэх хэрэгтэй. Нэгдүгээрт, та энгийн хэрэглэгчийн хувьд ойлгомжгүй тусгай нэр томъёог буруугаар ашиглах ёсгүй. Хоёрдугаарт, ашигласан нэр томъёо бүрийг нарийвчлан тайлбарлаж өгөх ёстой. Гуравдугаарт, та аль болох тодорхой, тодорхой бичих хэрэгтэй. Эцэст нь хэлэхэд, техникийн зохиолч өөрийн текстийн дутагдлыг олж харахын тулд өөрсдийн текстийг жирийн хэрэглэгчийн нүдээр харж чаддаг байх ёстой.
Алхам 5
Хэрэглэгчийн гарын авлагын дууссан текстийг практик дээр тайлбарласан бүтээгдэхүүнтэй ямар ч холбоогүй хүнд санал болгосноор туршиж үзэх нь сайн хэрэг. Хамтын хүчин чармайлтаар баримт бичгийн бүх дутагдал, бэрхшээлийг арилгах боломжтой.
