Dastur hujjatlarini tayyorlash qoidalari. espd, espd bo'yicha dasturiy hujjatlarni ro'yxatdan o'tkazish Gost bo'yicha dastur hujjatlarini ro'yxatdan o'tkazish

texnik vositalar dasturlari va boshqa dasturlar, kirish va chiqish ma'lumotlarining umumiy tavsiflari, shuningdek tashkiliy, texnik va texnologik xarakterdagi talablar va shartlar va boshqalar).

Masalan: Dastur IBM PC / AT tipidagi shaxsiy kompyuterda (ShK) ishlaydi. Dialog rejimida ishlash uchun displey ekrani, klaviatura va sichqonchadan foydalaniladi. Grafik rejimini qo'llab-quvvatlash uchun EGA (VGA) adapteri talab qilinadi. Kiritilgan ma'lumotlar floppi va / yoki qattiq disklarda saqlanadi. Dastur OS ostida ishlaydi ...

Ma'lumotnoma materiallari (rasmlar, jadvallar, grafiklar, misollar va boshqalar) tavsifga ilovaga kiritilishi mumkin.

Va yuklash modulining nomini, shuningdek, tizimga qo'ng'iroq qilish va yuklash bo'yicha butun protsedura tavsifini ko'rsatishni unutmang.

Masalan: Dastur DOS buyruq satriga yuklanadigan modul nomi - SBM80N.EXE ni kiritish orqali yuklanadi, ehtimol ma'lumotlar fayli nomini ko'rsatadi.

DASTUR MATNI (GOST 19.401-78)

Dastur matnini formatlash talablari malakali dasturchi uchun juda oddiy va tabiiydir. Ushbu hujjatni yaratishda rahbarlik qilish kerak bo'lgan asosiy narsa dastur matni o'qilishi kerak.

Axborot qismini - izoh va tarkibni tuzish hali ham majburiydir.

Hujjatning asosiy qismi bir yoki bir nechta bo'limlarning matnlaridan iborat bo'lishi kerak, ularga sarlavhalar beriladi.

Har bir dastur faylining matni "sarlavha" bilan boshlanadi, bu quyidagilarni bildiradi:

· dastur nomi,

· dastur yaratilgan sana,

Versiya raqami,

· oxirgi o'zgartirish sanasi.

Izohlar talab qilinadi, shuningdek, chekinish qoidalariga qat'iy rioya qilish kerak. Esingizda bo'lsin, siz hatto dasturiy ta'minot hujjatlarini yarata olmaslikni ham oqlashingiz mumkin. Va dasturning xunuk matni hech qachon. Ushbu matn muallifning o'zi uchun tushunarli ekanligiga havolalar jiddiy qabul qilinmaydi. Dasturlarning matnlarini boshqalarga o'qishga ruxsat berishdan uyalmaslik kerak.

DASTUR VA TEST TARTIBI (GOST 19.301-79)

Ushbu hujjat dasturning to'g'ri ishlayotganiga ishonch hosil qilish (va mijozni ishontirish) uchun nima va qanday qilish kerakligi tavsifini o'z ichiga oladi. Aslida, ushbu hujjat qabul qilish uchun hal qiluvchi ahamiyatga ega

testlar. Yaxshi ishlab chiqilgan dastur va test metodologiyasi qabul qilish sertifikatini imzolash kafolati hisoblanadi, ya'ni. Buning uchun siz ko'p vaqt va kuch sarfladingiz.

Rasmiy ravishda, ushbu GOST rejalashtirish hujjatlarini ishlab chiqish va dasturiy ta'minot tizimining tayyorligi va sifatini baholash uchun sinov ishlarini o'tkazish uchun ishlatiladi. Hujjatda sinov ob'ekti va maqsadining tavsifi, dastur va dasturiy ta'minot hujjatlariga qo'yiladigan talablar, sinovdan o'tkazish vositalari va tartibi, shuningdek test holatlarining tavsifi mavjud.

Ushbu hujjatning tarkibiy qismlarini darhol misollar shaklida tasvirlash osonroq va tushunarli.

Sinov ob'ekti

Misol: Test ob'ekti ... uchun mo'ljallangan dasturdir

Sinovlarning maqsadi

Misol: Dasturning ishonchliligini tekshirish.

Dasturga qo'yiladigan talablar

Misol: Dasturning ishlashi halokatga olib kelmasligi kerak (tizimning halokatli noto'g'ri ishlashi). Muloqotni tashkil etish noto'g'ri ma'lumotlarni kiritishdan himoya qilishni ta'minlashi kerak. Dastur tizim holatining diagnostikasini va sodir bo'lgan xatolar haqida xabarlarni berishi kerak ... va hokazo.

Dasturiy ta'minot hujjatlariga qo'yiladigan talablar

Misol: Sinov paytida taqdim etilgan dasturiy ta'minot hujjatlari tarkibi:

· dastur tavsifi (GOST 19.402-78);

· test dasturi va metodologiyasi (GOST 19.301-79);

· dastur matni (GOST 19.401-78).

Sinov usullari va tartibi

Misol: Dastur IBM PC / AT kabi shaxsiy kompyuterlarda, shuningdek, mos keluvchi kompyuterlarda MS DOS (versiyasi 3.0 dan past bo'lmagan) ning ishlash shartlariga muvofiq ishlaydi. Ishlash uchun adapter ham talab qilinadi.

Sinov jarayoni:

1. Dastur ... tomonidan ishga tushirilgan.

2. Tanlangan ...

3. Bosilgan ...

4. Ketma-ket tanlangan ...

Test holatlari

Misol: Sinov uchun, ... taklif etiladi, tavsifi fayllarda mavjud ... Test fayllari mazmuni va dastur natijalari 1-ilovada keltirilgan.

Va nihoyat, bizni qiziqtirgan so'nggi ESPD standartini ko'rib chiqing

Chop etish usuli bilan bajariladigan DASTUR HUJJATLARIGA TALABLAR (GOST 19.106-78)

Standart ESPD standartlarida nazarda tutilgan maqsad va ko'lamidan qat'i nazar, kompyuterlar, komplekslar va tizimlar uchun dasturiy hujjatlarni bajarish qoidalarini belgilaydi.

Umumiy talablar. Mashinada, mashinada va qo'lda yozilgan usullarda, individual so'zlar, formulalar, an'anaviy belgilar (chizilgan shriftda qo'lda), lotin va yunon alifbosi harflari bilan bajarilgan dasturiy hujjatlarga kiritish, shuningdek diagramma va chizmalarni bajarish kerak. qora siyoh yoki siyoh bilan.

Bajarish jarayonida aniqlangan matn terish xatolari va grafik noaniqliklarni matnning (chizmaning) noto‘g‘ri bajarilgan qismini o‘chirish va tuzatilgan matnni (grafiklarni) xuddi shu matn varag‘ida (grafikda) shrift yoki qora siyohda qo‘llash orqali tuzatishga ruxsat beriladi; hujjatni bajarish usuliga qarab.

Hujjatlar varaqlariga, to'liq o'chirilgan matnning (grafiklarning) dog'lari va izlariga zarar yetkazilishiga yo'l qo'yilmaydi.

Dastur hujjatlari A4 varaqlarida tuzilgan. bundan mustasno

· A3 formatidagi varaqlarda ro'yxatdan o'tishga ruxsat beriladi;

· hujjatni bajarishning mashina usuli bilan, foydalaniladigan texnik vositalarning imkoniyatlari bilan belgilanadigan A4 va A3 formatlariga mos keladigan varaq o'lchamlarida og'ishlarga yo'l qo'yiladi; Hujjatni mashinada ishlab chiqarishda ma'lumotlarni chiqarish qurilmalarining chiqish xarakteristikalari bilan ta'minlangan A4 va A3 formatidagi varaqlarda;

· hujjatni tipografik usulda tayyorlashda tipografik formatlar varaqlaridan foydalanish mumkin.

Dasturiy hujjat materiallarini joylashtirish quyidagi ketma-ketlikda amalga oshiriladi:

· sarlavha qismi:

- tasdiqlash varaqasi (hujjat varaqlarining umumiy soniga kiritilmagan);

- sarlavha sahifasi (hujjatning birinchi sahifasi);

· ma'lumot qismi:

Annotatsiya;

- tarkib varaqasi;

· Asosiy qism:

- hujjat matni (rasmlar, jadvallar va boshqalar bilan);

- atamalar ro'yxati va ularning ta'riflari;

- qisqartmalar ro'yxati;

Ilovalar;

- mavzu ko'rsatkichi;

- havola qilingan hujjatlar ro'yxati;

· o'zgarishlarni ro'yxatga olish qismi:

- ro'yxatga olish varaqasini o'zgartirish.

Hujjat yaratish. Agar kerak bo'lsa, hujjatni qismlarga ajratishga ruxsat beriladi. Qismlarga bo'linish qismdan past bo'lmagan darajada amalga oshiriladi. Har bir qism alohida to'ldiriladi, birinchi qismning mazmuni oxirida qolgan qismlarning nomlari ko'rsatilishi kerak.

Hujjatga dastur matni yoziladigan til qoidalariga muvofiq tuzilgan dastur matnining qismlarini kiritishga ruxsat beriladi.

Izoh “ANNOTATION” sarlavhasi bilan ta’minlangan, raqamlangan va hujjat mazmuniga kiritilgan alohida sahifa(lar)ga joylashtiriladi.

Har bir hujjatning matni, agar kerak bo'lsa, hujjat qismlarga, bo'limlarga va kichik bo'limlarga bo'linganmi yoki yo'qligidan qat'i nazar, paragraflarga, paragraflar esa - kichik bandlarga bo'linadi.

Bo'lim sarlavhalari bosh harf bilan yoziladi va matnning chap va o'ng chegaralariga nisbatan simmetrik tarzda joylashtiriladi. Kichik bo'limlar sarlavhalari kichik harflar bilan paragraf bilan yoziladi (birinchi bosh harfdan tashqari). Sarlavhalarda so'zlarni tire qo'yish mumkin emas. Sarlavha oxiriga nuqta qo'ymang. Har bir bo'limni yangi varaqdan boshlash tavsiya etiladi.

Bo'limlar, kichik bo'limlar, bandlar va kichik bandlar arab raqamlari bilan nuqta bilan raqamlanishi kerak. Bo'limlar ketma-ket raqamga ega bo'lishi kerak (1, 2 va boshqalar).

Hujjat matni. Hujjat matni qisqa, tushunarli bo'lishi kerak, noto'g'ri talqin qilish ehtimolini istisno qiladi. Atamalar va ta'riflar bir xil bo'lishi va belgilangan standartlarga mos kelishi kerak, ular yo'q bo'lganda - ilmiy va texnik adabiyotlarda umumiy qabul qilingan va atamalar ro'yxatida keltirilgan.

Hujjat matniga kerakli tushuntirishlar izohlar bilan tuzilishi mumkin. Izoh shriftning yuqori kesish chizig'i darajasida joylashgan qavsli raqam bilan ko'rsatilgan.

Agar izoh alohida so'zga tegishli bo'lsa, izoh belgisi to'g'ridan-to'g'ri ushbu so'zning yoniga qo'yiladi, lekin agar u butun gapni nazarda tutsa, u holda gap oxirida. Izoh matni sahifaning oxiriga joylashtiriladi va asosiy matndan sahifaning chap tomoniga chizilgan 3 sm chiziq bilan ajratiladi.

Tasvirlar. Rasmlar hujjat matnida va/yoki ilovalarda joylashtirilishi mumkin. Rasmlar, agar ushbu hujjatda bir nechta bo'lsa, butun hujjat bo'ylab arab raqamlari bilan raqamlangan.

Ilovalarda rasmlar har bir ilova ichida hujjatning asosiy matni uchun belgilangan tartibda raqamlangan. Tasvirlarga havolalar turi bo'yicha berilgan: "Fig.12" yoki "(Fig.12)". Illyustratsiyalar tematik sarlavha va illyustratsiya mazmunini tushuntiruvchi rasmli matnga ega boʻlishi mumkin.

Formulalar. Hujjatdagi formulalar, agar bir nechta bo'lsa, arab raqamlari bilan raqamlanadi, raqam varaqning o'ng tomonida, formulalar darajasida qavs ichida joylashtiriladi. Butun hujjat yoki uning qismlari ichida, hujjat qismlarga bo'lingan taqdirda, formulalar doimiy ravishda raqamlanadi.

Matndagi formulaning tartib raqamiga havolalar qavs ichida berilgan, masalan: “(3) formulada”. Hujjatni qismlarga bo'lishda qism raqami formulaning seriya raqamidan oldin joylashtiriladi va oxirgi nuqtadan ajratiladi, masalan: "(1.4) formulada".

Formulaga kiritilgan belgilarning ma'nosi to'g'ridan-to'g'ri formula ostida berilishi kerak. Har bir belgining ma'nosi formulada berilgan tartibda yangi satrda chop etiladi. Shifrni ochishning birinchi qatori "qaerda" so'zi bilan boshlanishi kerak, undan keyin ikki nuqta qo'yilmaydi.

Havolalar. Siyosiy hujjatlarda standartlarga va boshqa hujjatlarga havolalarga ruxsat beriladi. Hujjatga umuman yoki uning bo'limlariga havola qilish kerak (hujjatning nomi va nomi, bo'lim yoki arizaning raqami va nomi ko'rsatilgan).

Hujjatning va (yoki) bo'limlarning nomlarini ko'rsatmasdan faqat belgilanishini ko'rsatishga ruxsat beriladi. Boshqa hujjatning alohida bo'limlari, paragraflari va rasmlariga havolalarga yo'l qo'yilmaydi. Hujjatda paragraflar, rasmlar va alohida bo'limlarga havolalarga ruxsat beriladi.

Eslatmalar. Matn va jadvallarga eslatmalarda faqat ma'lumotnoma va tushuntirish ma'lumotlari ko'rsatilgan. Bitta eslatma raqamlanmagan. Keyin "Eslatma" so'zidan keyin nuqta qo'ying. Bir nechta eslatmalar ketma-ket arab raqamlari bilan nuqta bilan raqamlanishi kerak. Va bu holda, "Eslatma" so'zidan keyin ikki nuqta qo'yiladi. Eslatma matni faqat bitta interval bilan chop etilishi mumkin.

Qisqartmalar. Matndagi so'zlarning qisqartmasi va rasmlar ostidagi izohlarga yo'l qo'yilmaydi, bundan mustasno:

· GOSTda belgilangan qisqartmalar 2.316-68 va rus tilida umumiy qabul qilingan;

· dasturlarni, ularning qismlarini bildirish uchun ishlatiladigan qisqartmalar

va ish rejimlari, ishni boshqarish tillarida, dastur sozlamalarida va boshqalar lotin harflari bilan belgilanadi

alifbo.

Ilovalar. Tasvirlangan material, jadvallar yoki yordamchi matn qo'shimchalar shaklida berilishi mumkin. Ilovalar ushbu hujjatning davomi sifatida keyingi sahifalarda tuziladi yoki alohida hujjat sifatida chiqariladi.

Har bir dastur yuqori o'ng burchakda "Ilova" so'zi bilan yangi sahifadan boshlanishi va tematik sarlavhaga ega bo'lishi kerak. Agar hujjatda bir nechta ilova mavjud bo'lsa, barcha qo'shimchalar arab raqamlari bilan raqamlanadi ("#" belgisisiz), masalan:

1-ilova, 2-ilova va boshqalar.

Ilovani alohida hujjat sifatida berishda hujjat nomi ostida titul varag‘ida “Ilova” so‘zi, bir nechta ilova mavjud bo‘lganda esa uning tartib raqami ham ko‘rsatilishi kerak.

Foydalanuvchi uchun qo'llanma hujjatlari dasturiy mahsulot spetsifikatsiyasi

Foydalanuvchi hujjatlari deganda oxirgi foydalanuvchiga dasturiy ta'minot paketini o'rnatish va ishlatish bo'yicha ma'lumot beradigan hujjatlar tushuniladi. Paketdagi ma'lumotlar deganda dasturiy ta'minot to'plamining tashqi o'ramida takrorlangan ma'lumotlar tushuniladi. Uning maqsadi potentsial xaridorlarga dasturiy ta'minot to'plami haqida asosiy ma'lumotlarni taqdim etishdir.

Dasturiy ta'minot vositasi uchun foydalanuvchi hujjatlari foydalanuvchilarga dasturiy ta'minotdan foydalanish uchun qanday harakat qilish kerakligini tushuntiradi. Agar dastur foydalanuvchilar bilan har qanday shovqinni o'z ichiga olgan bo'lsa, bu zarur. Bunday hujjatlar ilova muhiti uchun mos sozlamalar bilan dasturni o'rnatishda, o'z vazifalarini hal qilish uchun dasturdan foydalanishda va dasturni boshqarishda (masalan, ushbu dasturiy vosita o'zaro ta'sir qilganda) foydalanuvchi boshqaradigan hujjatlarni o'z ichiga oladi.

bilan boshqa tizimlar). Ushbu hujjatlar dasturiy ta'minotga texnik xizmat ko'rsatish masalalarini qisman ko'rib chiqadi, ammo ular bilan bog'liq muammolarni hal qilmaydi

bilan dasturlarni o'zgartirish.

V Shu munosabat bilan foydalanuvchilarning ikkita toifasini ajratish kerak: oddiy dastur foydalanuvchilari va ma'murlar. Dasturning oddiy foydalanuvchisi(oxirgi foydalanuvchi) o'z muammolarini hal qilish uchun dasturdan foydalanadi (o'z mavzusi bo'yicha). Bu texnik qurilmani loyihalashtirgan muhandis yoki ushbu dastur yordamida poezd chiptalarini sotuvchi kassir bo'lishi mumkin. U kompyuterning ko'p tafsilotlarini yoki dasturlash tamoyillarini bilmasligi mumkin. Dastur administratori (tizim administratori) oddiy foydalanuvchilar tomonidan dasturdan foydalanishni boshqaradi va dasturlarni o'zgartirish bilan bog'liq bo'lmagan dasturiy ta'minotni saqlaydi. Masalan, u oddiy foydalanuvchilar o'rtasida dasturga kirish huquqlarini tartibga solishi, dasturni etkazib beruvchilari bilan aloqa qilishi yoki dastur boshqa tizimning bir qismi sifatida kiritilgan bo'lsa, uni ish holatida saqlash uchun muayyan harakatlarni bajarishi mumkin.

Foydalanuvchi hujjatlarining tarkibi u mo'ljallangan foydalanuvchilar auditoriyasiga va hujjatlardan foydalanish rejimiga bog'liq. Bu erda auditoriya foydalanuvchilar kontingentini anglatadi,

ma'lum foydalanuvchi hujjatlariga ehtiyoj bor. Muvaffaqiyatli foydalanuvchi hujjati asosan u mo'ljallangan auditoriyaning aniq ta'rifiga bog'liq. Foydalanuvchi hujjatlari har bir auditoriya uchun zarur bo'lgan ma'lumotlarni o'z ichiga olishi kerak. Hujjatdan foydalanish tartibi hujjatdan qanday foydalanishni belgilaydigan usulni bildiradi. Odatda, etarlicha katta dasturiy ta'minot tizimlaridan foydalanuvchi hujjatlarni dasturiy vositani o'rganish uchun (ko'rsatma sifatida foydalanish) yoki ba'zi ma'lumotlarni aniqlashtirish uchun (ma'lumotnoma sifatida foydalanish) talab qiladi.

Dasturiy ta'minotning umumiy funksional tavsifi. Dasturiy ta'minotning funksional imkoniyatlari haqida qisqacha ma'lumot beradi. U ushbu dasturiy vositaga qanchalik muhtojligini hal qilishi kerak bo'lgan foydalanuvchilar uchun mo'ljallangan.

Dasturiy ta'minot o'rnatish uchun qo'llanma. Tizim ma'murlari uchun mo'ljallangan. U ma'lum bir muhitda tizimlarni qanday o'rnatishni batafsil ko'rsatishi kerak. U dasturiy ta'minot bilan ta'minlangan mashina tomonidan o'qiladigan vosita tavsifini, dasturiy ta'minotni ifodalovchi fayllarni va apparat konfiguratsiyasiga minimal talablarni o'z ichiga olishi kerak.

Dasturiy ta'minotdan foydalanish bo'yicha ko'rsatmalar. Oddiy foydalanuvchilar uchun mo'ljallangan. Dasturiy ta'minotdan foydalanish bo'yicha kerakli ma'lumotlarni o'z ichiga oladi, uni o'rganish uchun qulay shaklda tashkil etilgan.

Dasturiy ta'minot vositalaridan foydalanish bo'yicha qo'llanma. Oddiy foydalanuvchilar uchun mo'ljallangan. Alohida qismlarni tanlab qidirish uchun qulay shaklda tashkil etilgan dasturiy ta'minotdan foydalanish bo'yicha zarur ma'lumotlarni o'z ichiga oladi.

Asboblarni boshqarish bo'yicha qo'llanma. Tizim ma'murlari uchun mo'ljallangan. U dasturiy ta'minot boshqa tizimlar bilan o'zaro aloqada bo'lganda hosil bo'ladigan xabarlarni va bu xabarlarga qanday javob berishni tasvirlashi kerak. Bundan tashqari, agar dasturiy vosita tizim uskunasidan foydalansa, ushbu hujjat ushbu uskunani qanday saqlash kerakligini tushuntirishi mumkin.

Foydalanuvchi hujjatlarini ishlab chiqish tashqi tavsif yaratilgandan so'ng darhol boshlanadi. Ushbu hujjatning sifati dasturning muvaffaqiyatini sezilarli darajada aniqlashi mumkin. Bu juda sodda va foydalanuvchilar uchun qulay bo'lishi kerak (aks holda asbob qurishga arzimasligi kerak edi). Shu sababli, foydalanuvchi hujjatlarining qoralamalari (eskizlari) dasturiy ta'minotni asosiy ishlab chiquvchilari tomonidan yaratilgan bo'lsa, ularning yakuniy versiyalarini yaratishda ko'pincha professional texnik yozuvchilar ishtirok etadilar.

Bundan tashqari, foydalanuvchi hujjatlarining sifatini ta'minlash uchun ushbu hujjatlarni ishlab chiqish tartibini belgilaydigan, foydalanuvchi hujjatlarining har bir turiga qo'yiladigan talablarni shakllantiradigan, ularning tuzilishi va mazmunini belgilaydigan bir qator standartlar ishlab chiqilgan.

1.4 Dasturchi uchun qo'llanma

Tizim hujjatlari ishlab chiqish nuqtai nazaridan dasturiy vositani tavsiflaydi.

Agar dasturiy ta'minot vositasi qanday tashkil etilganligini (loyihalanishini) o'rganish va dasturlarini yangilashni o'z ichiga olgan bo'lsa, ushbu hujjat zarur. Ta'kidlanganidek, texnik xizmat ko'rsatish doimiy rivojlanishdir. Shuning uchun, agar dasturiy ta'minotni modernizatsiya qilish zarurati tug'ilsa, bu ishga hamrohlik qiluvchi ishlab chiquvchilarning maxsus guruhi jalb qilinadi. Bu jamoa dasturiy ta'minotni ishlab chiqishning dastlabki (asosiy) jamoasiga rahbarlik qilgan xuddi shu hujjatlar bilan shug'ullanishi kerak, yagona farqi shundaki, bu hujjatlar odatda texnik xizmat ko'rsatuvchi jamoa uchun begona bo'ladi (u boshqa jamoa tomonidan yaratilgan). Ta'minotchini ishlab chiqish guruhi yangilanayotgan dasturiy ta'minotning arxitekturasi va ishlab chiqish jarayonini tushunish uchun ushbu hujjatlarni ko'rib chiqishi va ushbu hujjatlarga kerakli o'zgartirishlarni kiritishi kerak, bu asosan dastlabki dasturiy ta'minot yaratilgan ish jarayonlarini takrorlaydi.

Dasturiy ta'minotga texnik xizmat ko'rsatish hujjatlarini ikki guruhga bo'lish mumkin:

1. dasturiy ta'minot tizimlarining dasturlari va ma'lumotlar tuzilmalari va ularni ishlab chiqish texnologiyasini belgilovchi hujjatlar;

2. dasturiy ta'minotga o'zgartirish kiritishga yordam beradigan hujjatlar.

Birinchi guruh hujjatlari dasturiy ta'minotni ishlab chiqishning har bir texnologik bosqichining yakuniy hujjatlarini o'z ichiga oladi. U quyidagi hujjatlarni o'z ichiga oladi.

Dasturiy vositaning tashqi tavsifi (Talablar hujjati). Dasturiy ta'minot arxitekturasining tavsifi (tizim tavsifi

arxitektura), shu jumladan har bir dasturning tashqi spetsifikatsiyasi.

Har bir dasturiy ta'minot dasturi uchun uning modulli tuzilishining tavsifi, shu jumladan unga kiritilgan har bir modulning tashqi spetsifikatsiyasi.

Har bir modul uchun - uning spetsifikatsiyasi va tuzilishining tavsifi

(dizayn tavsifi).

Tanlangan dasturlash tilida modul matnlari (dastur manba kodi ro'yxatlari).

Vakolatlilik qanday tuzilganligini tavsiflovchi tasdiqlovchi hujjatlar

har bir dasturiy ta'minot dasturi va tekshirish ma'lumotlari dasturiy ta'minot talablari bilan qanday bog'langanligi.

Tasdiqlash hujjatlari birinchi navbatda sinov hujjatlarini (sinov dizayni va test toʻplamining tavsifini) oʻz ichiga oladi, lekin dasturiy taʼminotni tekshirishning boshqa turlari natijalarini, masalan, dastur xususiyatlarini isbotlashni oʻz ichiga olishi mumkin.

Ikkinchi guruh hujjatlari o'z ichiga oladi

Dasturiy ta'minot bilan birga ma'lum muammolarni tavsiflovchi tizimga texnik xizmat ko'rsatish bo'yicha qo'llanma tizimning qaysi qismlari apparat va dasturiy ta'minotga bog'liqligini va uni loyihalashda dasturiy ta'minotni ishlab chiqish qanday hisobga olinishini tavsiflaydi.

Dasturiy ta'minot vositasiga xizmat ko'rsatish bilan bog'liq keng tarqalgan muammo bu dasturiy ta'minot o'zgarganda uning barcha ko'rinishlari tezligini ta'minlash (mos keladigan bo'lishi). Bunga yordam berish uchun hujjatlar va ularning qismlari o'rtasidagi aloqalar va bog'liqliklar konfiguratsiyani boshqarish ma'lumotlar bazasida saqlanishi kerak.

Xulosa Zamonaviy ob'ektlarning murakkabligi va hajmining tez o'sishi

dasturlarning bir vaqtning o'zida bajarilgan funktsiyalar uchun mas'uliyatini oshirish mijozlar va foydalanuvchilar tomonidan ularning sifati va foydalanish xavfsizligiga qo'yiladigan talablarni keskin oshirdi. Sohaning yetakchi kompaniyalari vakillari ishtirokida ishlab chiqilgan hujjatlashtirish standartlari dasturlar va dasturiy ta’minot tizimlarining yuqori samaradorligi va sifatini ta’minlashning tasdiqlangan vositasidir.

Rossiyada murakkab dasturiy komplekslarning hayot aylanishi va sifatini ta'minlash sohasida asosan jahon darajasidan 5-10 yil orqada qolgan eskirgan GOSTlar guruhi qo'llaniladi.

So'nggi bir necha yil ichida dasturiy mahsulotlar sifatini ta'minlash tizimlari uchun asos bo'lib xizmat qilishi mumkin bo'lgan dasturiy vositalar va ma'lumotlar bazalarining hayot aylanishi jarayonlari va mahsulotlarini tartibga soluvchi ko'plab ISO standartlari yaratildi. Mahsulot sifatini yaxshilash uchun barcha dasturiy hujjatlar standartlarini bilishingiz va to'g'ri foydalanishingiz kerak.

G O S U D A R S T V E N Y S T A N D A R T S O Y Z A S S R

ACS uchun texnik hujjatlar tizimi

GOST 24.207-80

DASTURIY HUJJATLAR MAZMUNIGA TALABLAR

Kompyuter boshqaruv tizimlari uchun texnik hujjatlar tizimi. Dasturiy ta'minotdagi hujjatlar mazmuniga qo'yiladigan talablar

SSSR Davlat standartlari qo'mitasining 1980 yil 14 maydagi 2101-son qarori bilan joriy etish muddati belgilandi.

1981 yil 01.01

Ushbu standart boshqaruvning barcha darajalari (milliydan tashqari) uchun ishlab chiqilgan barcha turdagi avtomatlashtirilgan boshqaruv tizimlari (ACS) uchun texnik hujjatlarga taalluqlidir va GOST 24.101-80 ga muvofiq kiritilgan hujjatlarning mazmuniga qo'yiladigan talablarni belgilaydi. ACS loyihalarida dasturiy ta'minot hujjatlari.

1. UMUMIY QOIDALAR

1.1. Dasturiy ta'minot hujjatlari quyidagilar uchun mo'ljallangan:

  • "ACS dasturiy ta'minotining tavsifi" hujjatida dasturiy ta'minot uchun dizayn echimlarining tavsifi uchun.
  • dasturga (dasturlar majmuasiga) qo‘yiladigan talablarni “Texnik topshiriq” hujjatida belgilash;
  • dasturni (dasturlar majmuasini) qo'llab-quvvatlash, ishlab chiqarish va ishlashini ta'minlaydigan echimlarni tavsiflash "Tushuntirish yozuvi", "Ilova tavsifi", "Dastur tavsifi", "Spesifikatsiya", "Dasturchi uchun qo'llanma", " Operator uchun qo'llanma", "Dastur matni" , "Forma", "Protsedura va test metodologiyasi";
  • “Test ishining tavsifi” hujjatida dasturning (dasturlar majmuasining) bajarilishini tekshirish.

1.2. ACS tomonidan hujjatlarni ishlab chiqishda har bir hujjatning bo'limlari mazmuni tegishli qism doirasi bilan cheklanadi.

1.3. Yaratilayotgan avtomatlashtirilgan boshqaruv tizimlarining maqsadi va o'ziga xos xususiyatlariga qarab, ushbu standartda mazmuniga qo'yiladigan talablar belgilanmagan hujjatlarga qo'shimcha bo'limlarni kiritishga ruxsat beriladi. Hujjatning bir qismi uchun dizayn echimlarining yo'qligi tegishli bo'limda zarur tushuntirishlar bilan qayd etiladi.

1.4. “Texnik topshiriq”, “Tushuntirish xati”, “Ilova tavsifi”, “Spesifikasiya”, “Operator qo‘llanmasi”, “Dastur matni”, “Shakl”, “Sinov qilish tartibi va tartibi” hujjatlari mazmuniga qo‘yiladigan talablar GOST 19.201-78, GOST 19.404-79, GOST 19.502-78, GOST 19.202-78, GOST 19.505-79, GOST 19.401-78, GOST 19.501-78 va GOST 173.

(O'zgartirilgan nashr, 1-sonli tuzatish).

2. HUJJATLAR MAZMUNIGA TALABLAR

2.1. ACS dasturiy ta'minotining tavsifi

2.1.1. Hujjatda kirish qismi va bo'limlari bo'lishi kerak:

  • dasturiy ta'minot tuzilishi;
  • dasturiy ta'minot qismlarining asosiy funktsiyalari;
  • dasturiy ta'minotni ishlab chiqish usullari va vositalari;
  • operatsion tizim;
  • operatsion tizim imkoniyatlarini kengaytiruvchi vositalar.

2.1.2. Kirish qismida dasturiy ta'minotni ishlab chiqish uchun zarur bo'lgan texnik, axborot va boshqa turdagi ACS yordami haqida asosiy ma'lumotlar yoki ACS loyihasining tegishli hujjatlariga havola bo'lishi kerak.

2.1.3. "Dasturiy ta'minot tuzilishi" bo'limida dasturiy ta'minot qismlari ro'yxati, ularning o'zaro bog'liqligi va ularning har birini ajratib ko'rsatish asoslari ko'rsatilgan bo'lishi kerak.

2.1.4. "Dasturiy ta'minot qismlarining asosiy funktsiyalari" bo'limida dasturiy ta'minotning har bir qismi uchun asosiy funktsiyalarning maqsadi va tavsifi berilgan kichik bo'limlar bo'lishi kerak.

(O'zgartirilgan nashr, 1-sonli tuzatish).

2.1.5. "Dasturiy ta'minotni ishlab chiqish usullari va vositalari" bo'limida dasturiy ta'minot qismlarini ko'rsatgan holda ACS dasturiy ta'minotini ishlab chiqish uchun dasturlash usullari va vositalarining ro'yxati bo'lishi kerak, ularni ishlab chiqishda tegishli usullar va vositalar qo'llanilishi kerak.

2.1.6. "Operatsion tizim" bo'limida quyidagilar bo'lishi kerak:

  • tanlangan operatsion tizimning nomi, nomi va qisqacha tavsifi va uning doirasida ishlab chiqilgan dasturlar amalga oshiriladigan versiyasi, tanlangan versiyaning batafsil tavsifi berilgan manbalarni tanlash va ko'rsatish asoslanishi;
  • qo'llanmaning nomi, unga muvofiq operatsion tizimning tanlangan versiyasini yaratish amalga oshirilishi kerak;
  • operatsion tizimning tanlangan versiyasini yaratish variantiga qo'yiladigan talablar.

2.1.7. "Operatsion tizimning imkoniyatlarini kengaytiruvchi vositalar" bo'limida operatsion tizimning imkoniyatlarini kengaytiradigan har bir vosita uchun quyidagi bo'limlar bo'lishi kerak:

  • tovarning nomi, belgilanishi va qisqacha tavsifi, undan foydalanish zaruriyatini asoslash va tanlangan mahsulotning batafsil tavsifi berilgan manbani ko'rsatish;
  • qo'llanmaning nomi, unga muvofiq ishlatiladigan vosita ma'lum bir dastur uchun sozlanishi kerak;
  • Siz foydalanayotgan vositani sozlash uchun talablar.

2.2. Dastur tavsifi

2.2.2. Ilgari ishlab chiqilgan dasturiy ta'minotni qo'llash orqali olingan dastur (dasturlar majmuasi) uchun "Dastur tavsifi" hujjati "Dasturiy ta'minotni sozlash" bo'limi bilan to'ldirilishi kerak.

2.2.3. "Dasturiy ta'minot sozlamalari" bo'limida quyidagilar bo'lishi kerak:

  • foydalaniladigan dasturiy vositalarning nomi, belgilanishi, ularni moslashtirish uchun zarur bo'lgan protseduralarning tavsifi yoki ushbu vositalarning operatsion hujjatlariga havolalar;
  • dasturni olish uchun zarur bo'lgan foydalaniladigan dasturiy vositalar elementlarining ro'yxati (dasturlar majmuasi);
  • foydalaniladigan dasturiy ta'minotning operatsion hujjatlarida ko'rsatilgan tilda sozlash tavsifi.

2.3. Dasturchi uchun qo'llanma

2.3.1. Bo'limlarning tarkibi va ularning mazmuni to'g'risidagi hujjat GOST 19.504-79 ga muvofiq bo'lishi kerak va qo'shimcha ravishda "Dasturni taqdim etish shakli to'g'risida ma'lumot (dasturlar majmuasi)" bo'limini o'z ichiga oladi.

2.3.2. "Dasturni taqdim etish shakli (dasturlar majmuasi) to'g'risida ma'lumot" bo'limida dastur yozilgan tashuvchi haqida, tashuvchida yozilgan ma'lumotlarni kodlashning mazmuni va tizimi, shuningdek zarur ma'lumotlar bo'lishi kerak. vositadan ma'lumotlarni o'qish uchun.

2.3.3. Muayyan dastur shartlari uchun sozlanishi mumkin bo'lgan dastur (dasturlar majmuasi) uchun "Dasturchi uchun qo'llanma" hujjati quyidagi bo'limlarni o'z ichiga oladi:

  • dastur tuzilishi;
  • dasturni sozlash;
  • qo'shimcha funktsiyalar;
  • tizim dasturchisiga xabarlar.

2.3.4. 2.3.3-bandda sanab o'tilgan bo'limlar o'rniga ma'lum bir dastur uchun sozlanishi mumkin bo'lgan dastur (dasturlar majmuasi) uchun GOST 19.503-79 talablariga javob beradigan "Tizim dasturchisi uchun qo'llanma" alohida hujjatini ishlab chiqishga ruxsat beriladi. .

2.4. Test ishining tavsifi

2.4.1. Hujjatda quyidagi bo'limlar bo'lishi kerak:

  • tayinlash;
  • dastlabki ma'lumotlar;
  • hisoblash natijalari;
  • dasturni tekshirish (dasturlar majmuasi).

2.4.2. "Maqsad" bo'limida test ishi bilan tekshirilgan dastur (dasturlar majmuasi) tomonidan amalga oshirilganlar orasidan parametrlar ro'yxati va funksiyaning qisqacha tavsifi bo'lishi kerak.

2.4.3. "Dastlabki ma'lumotlar" bo'limida dasturni (dasturlar majmuasini) dastlabki ma'lumotlar bilan tekshirish uchun dastlabki ma'lumotlarning tavsifi bo'lishi kerak. Dastlabki ma'lumotlarni ADCUdan chop etish shaklida taqdim etishga ruxsat beriladi.

2.4.4. "Hisoblash natijalari" bo'limida sinovdan o'tgan funktsiyalarning to'g'riligini va tekshirilgan parametrlarning qiymatini baholashga imkon beruvchi dastur (dasturlar majmuasi) tomonidan dastlabki ma'lumotlarni qayta ishlash natijalari bo'lishi kerak. Hisoblash natijalarini ADCUdan chop etish shaklida berishga ruxsat beriladi.

2.4.5. "Dasturni tekshirish (dasturlar majmuasi)" bo'limida quyidagilar bo'lishi kerak:

  • dasturning ishlashi uchun zarur bo'lgan texnik vositalar tarkibining tavsifi (dasturlar majmuasi) yoki tegishli dasturiy hujjatlarga havola;
  • dasturni (dasturlar majmuasini) tekshirish, sinovdan o'tgan dasturni (dasturlar majmuasini) chaqirish va hisoblash natijalarini olish uchun dastlabki ma'lumotlarni yaratish tartib-qoidalarining tavsifi;
  • test misoli yordamida dastlabki ma'lumotlarni tayyorlash va dasturni (dasturlar majmuasini) tekshirishda operator harakatlarining tavsifi.
* 1985 yil avgust oyida tasdiqlangan (IUS 11-85) №1 tuzatish bilan qayta nashr etilgan (1986 yil may).
Yuqoriga

GOST 19.105-78 * (Dastur hujjatlari uchun umumiy talablar)

Ushbu GOSTdan biz olamizdastur hujjatlarini loyihalash uchun umumiy talablar.Quyida eng muhim bo'limlar mavjud.

  • Ushbu standart kompyuterlar, komplekslar va tizimlar uchun dasturiy hujjatlarni loyihalash uchun umumiy talablarni belgilaydi, ularning maqsadi va ko'lamidan qat'i nazar va Yagona dasturiy hujjatlar tizimi (ESPD) standartlarida turli xil ma'lumotlar tashuvchilarda hujjatlarni rasmiylashtirishning har qanday usuli uchun nazarda tutilgan.
  • Dastur hujjati quyidagi shartli qismlardan iborat:
    • sarlavha;
    • axborot;
    • Asosiy;
    • o'zgarishlarni ro'yxatdan o'tkazish.
  • Sarlavha qismi bayonot varaqasi va sarlavha sahifasidan iborat. Tasdiqlash varaqasi va sarlavha sahifasini tuzish qoidalari GOST 19.104-78 ga muvofiq belgilanadi.
  • Axborot qismi izoh va mazmundan iborat bo'lishi kerak.
    • Axborot qismini har xil turdagi dasturiy hujjatlarga kiritish zarurati ushbu hujjatlar uchun tegishli EAPD standartlari bilan belgilanadi.
    • Annotatsiya hujjatning maqsadi va uning asosiy qismining qisqacha mazmuni haqida ma'lumot beradi.
    • Tarkib hujjatning asosiy qismining tarkibiy elementlari to'g'risidagi yozuvlar ro'yxatini o'z ichiga oladi, ularning har biri quyidagilarni o'z ichiga oladi:
      • strukturaviy elementni belgilash (bo'lim, kichik bo'lim va boshqalar raqami);
      • strukturaviy elementning nomi;
      • ma'lumotlar tashuvchisidagi strukturaviy elementning manzili (masalan, sahifa raqami, fayl raqami va boshqalar).
  • Dastur hujjatining asosiy qismining tarkibi va tuzilishi tegishli hujjatlar uchun ESPD standartlari bilan belgilanadi.
  • O'zgarishlarni ro'yxatga olish qismi(har bir siyosat hujjatiga kiritilishi kerak)
    • Ushbu qismdagi dastur hujjatidagi har bir o'zgarish GOST 19.603-78 talablariga muvofiq qayd etiladi.
Yuqoriga
==================================
GOST 19.106-78 * (Bosma nashrlarda tayyorlangan dasturiy hujjatlar uchun umumiy talablar
yo'l)
Ushbu GOSTdan biz olamiz umumiy qoidalar chop etish usuli uchunsiyosiy hujjatlar. Quyida eng muhim bo'limlar mavjud.
  • Ushbu standart maqsad va ko'lamidan qat'i nazar, kompyuterlar, komplekslar va tizimlar uchun dasturiy hujjatlarni bajarish qoidalarini belgilaydi va bosma bajarish usuli uchun Yagona dasturlash hujjatlari tizimining (ESPD) standartlarida nazarda tutilgan.
  • Standart "Dastur matni" dasturiy hujjatiga taalluqli emas.
  • Dastur hujjatining tarkibi va tuzilishi GOST 19.105-78 ga muvofiq belgilanadi.
  • Dastur hujjati bajariladivaraqning bir tomonida, ikki oraliqda; bir yoki bir yarim oraliqda ruxsat etiladi.
  • Dastur hujjatlari tuziladi:
    • A4 varaqlarida (GOST 2.301-68) - hujjatni mashinkada yoki qo'lda yozish usuli bilan tuzishda (1-shakl). A3 formatidagi varaqlarda ro'yxatdan o'tishga ruxsat beriladi.


  • Dasturiy hujjatning materiallari quyidagi ketma-ketlikda joylashtirilgan:
    • sarlavha qismi:
      • tasdiqlash varaqasi (hujjat varaqlarining umumiy soniga kiritilmagan);
      • sarlavha sahifasi (hujjatning birinchi sahifasi);
    • ma'lumot qismi:
      • izoh;
      • tarkib varaqasi;
    • Asosiy qism:
      • hujjat matni (rasmlar, jadvallar va boshqalar bilan);
      • ilovalar;
      • atamalar ro'yxati, qisqartmalar ro'yxati, raqamlar ro'yxati, jadvallar ro'yxati, mavzu ko'rsatkichi, ma'lumotnomalar ro'yxati;
    • o'zgarishlarni ro'yxatga olish qismi:
      • ro'yxatga olish varaqasini o'zgartirish.
  • Izoh "ANNOTATION" sarlavhasi bilan alohida (raqamlangan) sahifaga joylashtiriladi va bo'lim sifatida raqamlanmaydi.
    • Annotatsiya dasturning nashrini ko'rsatadi, hujjatning maqsadi va mazmunini qisqacha tavsiflaydi. Agar hujjat bir necha qismdan iborat bo'lsa, izohda qismlarning umumiy soni ko'rsatiladi.
  • Hujjat mazmuni izohdan keyin alohida (raqamlangan) varaq(lar)ga joylashtiriladi, “MAZMUNI” sarlavhasi bilan ta’minlanadi, bo‘lim sifatida raqamlanmaydi va hujjatning umumiy varaqlari soniga kiritiladi.
  • Bo'lim sarlavhalari bosh harf bilan yoziladi va matnning chap va o'ng chegaralariga nisbatan simmetrik tarzda joylashtiriladi.
  • Kichik bo'limlar sarlavhalari kichik harflar bilan paragraf bilan yoziladi (birinchi bosh harfdan tashqari).
  • Sarlavhalarda so'zlarni tire qo'yish mumkin emas. Sarlavha oxiriga nuqta qo'ymang.
  • Sarlavha va keyingi matn, shuningdek bo'lim va kichik bo'lim sarlavhalari orasidagi masofa quyidagilarga teng bo'lishi kerak:
    • hujjatni mashinkada yozishda bajarishda - ikki oraliq.
  • Matni oldingi bo'lim matni bilan bir sahifada yozilgan bo'limlar va bo'limlar uchun matnning oxirgi qatori va keyingi sarlavha o'rtasidagi masofa teng bo'lishi kerak:
    • hujjatni mashinada yozishda bajarishda - uchta matn terish oralig'i.
  • Bo'limlar, kichik bo'limlar, bandlar va kichik bandlar arab raqamlari bilan nuqta bilan raqamlanishi kerak.
  • Bo'lim ichida ushbu bo'limga kiritilgan barcha bo'limlar, bandlar va kichik bandlar uchun doimiy raqamlash bo'lishi kerak.
  • Bo'limlarni raqamlash bo'limning raqamini va ushbu bo'limga kiritilgan bo'limning tartib raqamini nuqta bilan ajratilgan (2.1; 3.1 va boshqalar) o'z ichiga oladi.
  • Agar bo'limlar va bo'limlar mavjud bo'lsa, band va kichik bandning tartib raqami (3.1.1, 3.1.1.1 va boshqalar) nuqtadan keyin kichik bo'lim raqamiga qo'shiladi.

Dastur hujjati matnining tuzilishi va uning bo'limlari, bo'limlari, bandlari va kichik bandlarining raqamlanishiga misol.

  • Hujjat matni qisqa, tushunarli bo'lishi kerak, noto'g'ri talqin qilish ehtimolini istisno qiladi.
  • Atamalar va ta'riflar bir xil bo'lishi va belgilangan standartlarga mos kelishi kerak, ular yo'q bo'lganda - ilmiy va texnik adabiyotlarda umumiy qabul qilingan va atamalar ro'yxatida keltirilgan.
  • Hujjat matniga kerakli tushuntirishlar izohlar bilan tuzilishi mumkin.
    • Izoh shriftning yuqori cheti darajasida joylashgan qavsli raqam bilan belgilanadi, masalan: "chop etish qurilmasi 2) ..." yoki "qog'oz 5)".
    • Agar izoh alohida so'zga tegishli bo'lsa, izoh belgisi to'g'ridan-to'g'ri ushbu so'zning yoniga qo'yiladi, lekin agar u butun gapga tegishli bo'lsa, u holda gap oxirida. Izoh matni sahifaning oxiriga joylashtiriladi va asosiy matndan sahifaning chap tomoniga chizilgan 3 sm chiziq bilan ajratiladi.
  • Rasmlar, agar ushbu hujjatda bir nechta bo'lsa, butun hujjat bo'ylab arab raqamlari bilan raqamlangan.
  • Hujjatdagi formulalar, agar bir nechta bo'lsa, arab raqamlari bilan raqamlanadi, raqam varaqning o'ng tomonida, formulalar darajasida qavs ichida joylashtiriladi.
  • Formulaga kiritilgan belgilar va raqamli koeffitsientlarning ma'nosi to'g'ridan-to'g'ri formula ostida berilishi kerak. Har bir belgining ma'nosi formulada berilgan tartibda yangi satrda chop etiladi. Shifrni ochishning birinchi qatori "qaerda" so'zi bilan boshlanishi kerak, undan keyin ikki nuqta qo'yilmaydi.
  • Dastur hujjatlarida standartlarga (korxona standartlari bundan mustasno), texnik shartlarga va boshqa hujjatlarga (masalan, davlat nazorati organlarining hujjatlari, SSSR Gosstroy qoidalari va normalari) havolalarga ruxsat beriladi. Standartlar va spetsifikatsiyalarga murojaat qilganda, ularning belgilanishini ko'rsating.
  • Hujjatga umuman yoki uning bo'limlariga havola qilish kerak (hujjatning nomi va nomi, bo'lim yoki arizaning raqami va nomi ko'rsatilgan). Bo'lim yoki ilovaga qayta murojaat qilganda faqat raqam ko'rsatiladi.
  • Matn va jadvallarga eslatmalarda faqat ma'lumotnoma va tushuntirish ma'lumotlari ko'rsatilgan.
    • Bitta eslatma raqamlanmagan. "Eslatma" so'zidan keyin nuqta qo'ying.
    • Bir nechta eslatmalar ketma-ket arab raqamlari bilan nuqta bilan raqamlanishi kerak. “Eslatma” so‘zidan keyin ikki nuqta qo‘yiladi.
  • Matndagi so'zlarning qisqartmasi va rasmlar ostidagi izohlarga yo'l qo'yilmaydi.
  • Tasvirlangan material, jadvallar yoki yordamchi matn qo'shimchalar shaklida berilishi mumkin.
  • Har bir ilova yangi sahifadan boshlanib, yuqori o‘ng burchakda “ILOVA” so‘zi ko‘rsatilgan va matnga simmetrik ravishda bosh harflar bilan yozilgan mavzuli sarlavhaga ega bo‘lishi kerak.(oxir-oqibat, loyihani yaratish uchun bizga faqat o'zgarishlarni ro'yxatga olish varag'i kerak).
    • Ushbu standart Yagona dasturiy hujjatlar tizimi (ESPD) standartlarida nazarda tutilgan va bosma nashrlarda rasmiylashtirilgan dasturiy hujjatlarga o'zgartirishlar kiritish qoidalarini belgilaydi.
    Ushbu GOSTdagi ma'lumotlarning katta miqdori va ushbu sahifadagi joyni tejash uchun men sizga mustaqil ravishda qarashingizni maslahat beraman. GOST 19.604-78 * ... Tayyor dizayn namunasi"Ro'yxatdan o'tish varaqasini o'zgartirish"YUKLASH bo'limida taqdim etilgan har qanday siyosat hujjatida ko'rishingiz mumkin

    Yuqoriga
    ==================================

Ro'yxatdan o'tish qoidalari va kurs ishining mazmuniga qo'yiladigan talablar

2-nashr

loyihalar (ishlar) va yakuniy saralash ishlari

39/73 sahifa

Yig'ish birligining yig'ish chizmasi

1-mahsulotga kiritilgan 8 raqami ostida

Kompyuter.760108.000 SB

Alohida yig'ilishning yig'ish chizmasi

birliklar 4

Kompyuter.760004.000 SB

Alohida yig'ilishning umumiy ko'rinishi chizmasi

birliklar 4

PC.760004.000 VO

16-qismning chizmasi kiritilgan

yig'ish birligi 8 mahsulot 1

120-qismning chizmasi, kiritilgan

alohida yig'ish birligi 4

Mahsulotning elektr sxematik diagrammasi 1

Kompyuter.760100.000 E3

Kinematik diagramma, printsip, alohida

yig'ish birligi 4

PK.760400.000 K3

Yig'ish birligining spetsifikatsiyasi 8 mahsulot 1

10 Texnologik hujjatlarni rasmiylashtirish

10.1 Kurs loyihalari (ishlari) va yakuniy malakaviy ishlarning texnologik hujjatlari ESTD standartlari talablariga muvofiq tuziladi.

10.2 Texnologik hujjatlar quyidagilarni o'z ichiga olishi kerak:

GOSTga muvofiq ishlab chiqilgan sarlavha sahifasi 3.1105-84 "ESTD. Umumiy hujjatlarni rasmiylashtirish shakli va qoidalari ”(shakl 2a).

marshrut xaritasi, GOSTga muvofiq chiqarilgan 3.1118-82 "ESTD. Marshrut xaritalarini ro'yxatdan o'tkazish shakllari va qoidalari ";

ishlov berish sxemalari va operatsion jadvallarini qayta ishlash

texnologik operatsiyalar uchun hisob-kitob va texnologik kartalar, CNC dastgohlarida - GOST 3.1404-86 "ESTD. Texnologik jarayonlar va kesish operatsiyalari uchun hujjatlarni rasmiylashtirish shakllari va qoidalari ";

chilangar operatsion kartalari, GOST 3.1407-86 "ESTD" bo'yicha o'rnatish va montaj ishlari. Yig‘ish usullari bo‘yicha ixtisoslashtirilgan texnologik jarayonlar (operatsiyalar) bo‘yicha hujjatlarni to‘ldirish va rasmiylashtirish shakllari va talablari”;

GOST bo'yicha eskizlarning xaritalari (agar kerak bo'lsa). 3.1105-84 va GOST 3.1128-93 "ESTD. Grafik texnologik hujjatlarni bajarishning umumiy qoidalari ";

GOSTga muvofiq texnologik nazoratning operatsion sxemalari 3.1502-85 "ESTD. Texnik nazorat uchun hujjatlarni rasmiylashtirish shakllari va qoidalari ";

boshqa texnologik hujjatlar (agar kerak bo'lsa yoki loyiha rahbarining qarori bilan).

10.3 Ta'mirlash chizmalari GOST 2.604-88 "Ta'mirlash chizmalari" da nazarda tutilgan qoidalarga muvofiq amalga oshiriladi.

10.4 Texnologik hujjatlar bog'langan bo'lishi kerak

to'g'ridan-to'g'ri kurs (loyiha) ishining tushuntirish yozuvida yoki ilovalar, texnik shartlar va elementlar ro'yxatidan keyin. Texnologik hujjatlar o'z raqamlashiga ega.

11 Dastur hujjatlarini ro'yxatga olish

11.1 Kurs loyihalari (ishlari) va yakuniy malakaviy ishlarda ishlab chiqilgan turli muammoli yo'nalishlarning hujjatlari quyidagicha tuzilishi kerak:

dasturiy hujjatlar - ESPD talablariga muvofiq,

avtomatlashtirilgan boshqaruv tizimi uchun hujjatlar - avtomatlashtirilgan boshqaruv tizimi uchun texnologik hujjatlar tizimining davlat standartlariga muvofiq. 11.2 Dastur hujjatlari (dastur ro'yxati) quyidagilarni o'z ichiga olishi kerak:

GOST 19.401 ga muvofiq tuzilgan dastur matni;

GOST 19.402 ga muvofiq tuzilgan dasturning tavsifi;

GOST 19.502 ga muvofiq berilgan eslatmaning tavsifi;

boshqa siyosat hujjatlari (agar kerak bo'lsa).

11.3 Dastur ro'yxatlari PPda ularga majburiy havolalar bilan qo'shimchalarga joylashtirilgan.

11.4 Dastur kodi sharhlar bilan birga bo'lishi mumkin. Ro'yxatlarni loyihalashda Courier New shriftidan foydalanish tavsiya etiladi, hajmi - 12 pt, qatorlar oralig'i - bitta. Semantik bloklarni bo'sh satrlar bilan ajratish, shuningdek, ichki o'rnatilgan konstruktsiyalarni indentlar bilan vizual ravishda belgilash tavsiya etiladi.

11.5 Dastur ro'yxatidagi kalit so'zlar va sharhlar kursiv bilan yozilishi mumkin. PPning asosiy matnida kursivlar kutubxonalar, pastki dasturlar, konstantalar, o'zgaruvchilar va boshqalar nomlarini ajratib ko'rsatish uchun ishlatilishi kerak.

11.6 Dastur ro'yxatlari ilova ichida ketma-ket raqamlangan bo'lishi kerak. Ro'yxat raqami dastur belgisi va nuqta bilan ajratilgan listing seriya raqamidan iborat bo'lishi kerak, masalan: "Ro'yxat A.3" - A ilovasining uchinchi ro'yxati. Agar loyiha (ish) faqat bitta ro'yxatni o'z ichiga olsa, u "Ro'yxat 1" deb belgilangan. PP matnidagi listingga murojaat qilganda, uning raqamini ko'rsatgan holda "Ro'yxat" so'zi yozilishi kerak.

11.7 Dastur ro'yxatining nomi asosiy matn bilan bir xil shriftda tuziladi va listing raqamidan keyin tire orqali, chap tarafdagi ro'yxatning tepasida, xatboshisiz joylashtiriladi.

Dastur ro'yxatiga misol Listing A.3 - "Ikki o'lchovli massivni chiqarish" dasturi

mas: butun sonlar massivi; ( ikki o'lchovli massiv deklaratsiyasi) i, j: butun son;

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

(Masiv elementlarining qiymatlarini kiritish) i uchun: = 1 dan 5 gacha

j uchun: = 1 dan 5 gacha do readln (mas);

(Masiv elementlarining qiymatlarini ko'rsatish) i uchun: = 1 dan 5 gacha boshlanadi

j uchun: = 1 dan 5 gacha yozing ("", mas); yozish;

12 Norm nazorati

12.1 Norm nazorati kurs loyihasi (ish) va WRC uchun hujjatlarni ishlab chiqishning yakuniy bosqichidir.

12.2 Norm nazorati GOST 2.111 talablariga muvofiq bo'lishi kerak.

12.3 Yakuniy malaka ishlari normativ nazoratdan o'tkaziladi. Kurs loyihalari (ishlari) bo'yicha namunaviy nazorat o'qituvchi tomonidan ishni himoya qilishda amalga oshiriladi. Standart nazoratni o'tkazish GOST, ESKD, ESPD va ESTD standartlari talablariga muvofiq kurs loyihalari (ishlari) va WQP (keyingi o'rinlarda hujjatlar) matn va grafik hujjatlarini to'g'ri bajarishga qaratilgan.

12.4 Muvofiqlik amaldagi standartlar va talablarni hisobga olgan holda tartibga soluvchi inspektor tomonidan amalga oshiriladi normativ-texnik hujjatlar.

12.5 Kurs loyihalari (ishlari) va WRC tushuntirish yozuvlarini standart nazorat qilish jarayonida quyidagilar tekshiriladi:

- ushbu Nizomga muvofiq ro'yxatga olish qoidalariga rioya qilish;

- PZ ko'rinishi;

- loyiha topshirig'iga muvofiq PPning to'liqligi;

- titul varag'ini to'g'ri to'ldirish, kerakli imzolarning mavjudligi;

- loyiha (ish) bayonnomasini to'ldirishning to'g'riligi;

- barcha sahifalarda ramkalar, asosiy yozuvlarning mavjudligi va to'g'riligi;

- sarlavhalar, bo'limlar va bo'limlarni ajratib ko'rsatish, qizil chiziqlar mavjudligi;

- mazmunning to‘g‘ri formatlanishi, mazmundagi bo‘lim va bo‘limlar sarlavhalarining eslatma matnidagi mos nomlarga mos kelishi;

- sahifalar, bo'limlar, bo'limlar, rasmlar, jadvallar, formulalarni to'g'ri raqamlash;

- chizmaning to'g'riligi;

- jadvallarning to'g'riligi;

- fizik kattaliklarning o'lchamlarining to'g'riligi, ularning SIga muvofiqligi;

- zamonaviy rus tili me'yorlariga rioya qilish;

- qo'llaniladigan so'z qisqartmalarining to'g'riligi;

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

foydalanilgan manbalarga havolalarning mavjudligi va to'g'riligi;

me'yoriy hujjatlarga havolalarning mavjudligi va to'g'riligi;

foydalanilgan manbalar ro'yxatining to'g'riligi;

ilovalarni to'g'ri loyihalash.

12.6 Kurs loyihalari (ishlari) va WRCning grafik hujjatlarini standart nazorat qilish jarayonida quyidagilar tekshiriladi:

chizma loyihasining amaldagi standartlar talablariga muvofiqligi;

me'yoriy hujjatlar talablariga muvofiq chizmalarni bajarish;

formatlarga muvofiqligi, ularni loyihalashning to'g'riligi;

konturning to'g'riligi va chiziqlar qo'llanilishi;

tarozilarga rioya qilish, ularni belgilashning to'g'riligi;

tasvirlarning etarliligi (turlari, bo'limlari, bo'limlari), ularning belgilanishi va joylashishining to'g'riligi;

diagrammalardagi elementlarning belgilariga va ularni ESKD talablariga muvofiq amalga oshirish qoidalariga muvofiqligi.

12.7. Yakuniy saralash ishlarining standart nazoratini ikki bosqichda o'tkazish tavsiya etiladi: dastlabki hujjatlarni qo'pol (yoki ingichka chiziqlarda) va yakuniy ishlab chiqishdan keyin. Ishlab chiqilayotgan hujjatlar to'liq to'plamda normativ nazoratga topshirilishi kerak, ya'ni. matn (tushuntirish yozuvi) va grafik hujjatlar (chizmalar, texnik shartlar va boshqalar).

12.8 Ilmiy rahbarning mulohazalari ro'yxati nazorat talaba ishlab chiquvchi yo'qligida amalga oshirilgan va xatolarning mohiyati u tomonidan noto'g'ri talqin qilinishi mumkin bo'lgan hollarda tuziladi.

12.9 Normativ nazoratchi tomonidan talaba ishlab chiquvchisi ishtirokida tekshirilgan hujjatlar sharhlar ro'yxati (agar tuzilgan bo'lsa) bilan birgalikda tuzatish va qayta ko'rib chiqish uchun talabaga qaytariladi. Agar sharhlar mavjud bo'lsa, inspektorning yozuvlari hujjatga imzo chekmaguncha saqlanadi. Agar hujjat talaba tomonidan qayta ishlansa, ikkala nusxa ham qayta nazoratga topshiriladi: rahbarning baholari bilan va qayta ko'rib chiqiladi.

12.10 Nazorat qiluvchi inspektorga imzolash uchun taqdim etilgan hujjatlarda bo'lim boshlig'ining vizasidan tashqari barcha tasdiqlash vizalari bo'lishi kerak. Atama va diplom loyihalarining (ishlarining) toza asl nusxalari nazoratchi tomonidan imzolanadi

v ustun "N.contr." sarlavha bloki.

12.11 Rahbarning xabarisiz kirish taqiqlanadi ushbu hujjat tartibga soluvchi inspektor tomonidan imzolangan va tasdiqlanganidan keyin hujjatga kiritilgan har qanday o'zgartirishlar.

12.12 Nazoratchi asosli hollarda taqdim etilgan hujjatni imzolamaslik huquqiga ega:

- me'yoriy hujjatlar talablariga rioya etilmagan taqdirda;

- majburiy imzolar bo'lmaganda;

- ehtiyotsizlik bilan bajarilgan taqdirda;

- belgilangan to'liqlik buzilgan taqdirda.

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

12.13 Standart nazoratchi ishlab chiqilgan hujjatlardagi amaldagi standartlar va boshqa normativ-texnik hujjatlar talablariga muvofiqligi uchun hujjatlarni ishlab chiquvchilar bilan teng ravishda javobgardir.

13 WRC sharhi

13.1 Himoyaga taqdim etilgan bitiruv malakaviy ishiga qo‘shimcha ob’ektiv baho olish uchun tegishli soha mutaxassislari tomonidan yakuniy malaka ishini tashqi ko‘rib chiqish amalga oshiriladi.

13.2 Yakuniy malakaviy ishlarning taqrizchilari yuqori malakali mutaxassislar bo'lib, ularning shaxsiy ro'yxati emissiya bo'limi tomonidan belgilanadi. Sharhlovchilar ishtirok etishi mumkin boshqa universitetlarning amaliyotchilari va o'qituvchilari.

Ko‘rib chiqish uchun yo‘llanma beruvchi bo‘lim tomonidan beriladi, uning shakli ushbu Qoidalarning T-ilovasida keltirilgan.

13.3 Taqrizchi yakuniy malakaviy ish (WQ) uchun barcha talablar bilan tanish bo'lishi kerak.

13.4 Ko'rib chiqish yozma ravishda amalga oshiriladi va asosli baholarni o'z ichiga oladi:

- WRC mavzusining dolzarbligi;

- FQP mazmunining uni ishlab chiqish topshirig'iga muvofiqligi;

- WRC mantiqiy tuzilishining to'g'riligi;

- loyihaviy yechimlarning samaradorligi va asosliligi;

- FQPning afzalliklari va kamchiliklari, uning bitiruvchining kadrlar tayyorlash sohasidagi malaka talablariga muvofiqligi;

- FQP ro'yxatdan o'tish.

Ko'rib chiqishning yakuniy qismida mavzuni ishlab chiqishning to'liqligi, qo'yilgan vazifalarga muvofiq, WRCning nazariy yoki amaliy ahamiyati va natijalaridan foydalanishning mumkin bo'lgan sohalari to'g'risida xulosalar beriladi. WRC. Taqrizchi ishni to'rt balli tizimda ("a'lo", "yaxshi", "qoniqarli", "qoniqarsiz") baholaydi va talabaga tegishli malakani berish imkoniyatini ko'rsatadi.

13.5 Yakuniy malakaviy ish uchun ko'rib chiqish hajmi bo'lishi kerak 2-3 varaq bosma yoki aniq qo'lda yozilgan matn. Imzolangan sharh FQP himoyasidan kamida uch kun oldin bo'limga topshirilishi kerak.

13.6 Ko'rib chiqish tashkilotning blankida (taqrizchining ish joyida) yoki ushbu Qoidalar bilan tartibga solingan (U-ilova) va tashkilotning muhri yoki muhri bilan tasdiqlangan belgilangan shakldagi blankada amalga oshirilishi mumkin. kadrlar bo'limi (umumiy bo'lim, idora) "imzo to'g'ri" belgisi bilan.

13.7 FQPni himoya qilish uchun davlat attestatsiya komissiyasi qo'shimcha ravishda etakchi tashkilotning ko'rinishini taqdim etishi mumkin, uning buyrug'i bilan

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

WRC o'tkazildi. Fikr-mulohazalar olingan natijalarning amaliy ahamiyatini ko'rsatishi kerak.

14 WRC uchun fikr-mulohazalar

14.1 Yakuniy malaka ishi bo'yicha fikr-mulohaza bevosita uning rahbari tomonidan tuziladi. Ko'rib chiqish FQPni turli tomonlardan tavsiflashi kerak: mazmuni, tuzilishi, tanlangan mavzuni ochishning to'liqligi va boshqalar.

14.2 Rahbar taqrizda talabaning bitiruv malakaviy ishi bo'yicha ob'ektiv fikrini bayon qilishi kerak. Xususan, ko'rib chiqish quyidagi ma'lumotlarni o'z ichiga olishi kerak:

- ish mavzusining dolzarbligi haqida;

- yakuniy malakaviy ishning standartlar talablariga muvofiqligi to'g'risida;

- talabaning kasbiy faoliyat sohasida qo'llaniladigan ma'lumotlarni to'plash, qayta ishlash va tahlil qilish usullariga ega bo'lishi to'g'risida;

- o'quvchining materialni aniq, izchil bayon qilish uchun manbalar bilan mustaqil ishlash qobiliyati haqida;

- ishning ijobiy tomonlari haqida;

- kamchiliklar va ish mazmuniga oid mulohazalar va boshqalar haqida.

14.3 Rahbarning yakuniy malakaviy ishini ko'rib chiqishda ishni umumiy baholash bo'yicha takliflar bo'lishi mumkin.

14.4 Ko'rib chiqish yakunida rahbar DJJda himoya qilish uchun bitiruv malakaviy ishini himoyaga topshirish mumkin degan xulosaga keladi.

14.5 Rahbarning FQPga javobi matni A4 varaqlarida chop etiladi va rahbar tomonidan imzolanadi. WRC bilan fikr-mulohaza shakli F-ilovada keltirilgan.

15 Hisobot va taqdimot

15.1 Ma'ruza (ma'ruza) - bu WRCning mohiyatini aks ettiruvchi taqdimot ishi.

Ma'ruzada tanlangan mavzuning dolzarbligi, ishning nazariy va uslubiy asoslariga to'xtalib o'tish, shuningdek, tadqiqot jarayonida olingan natijalarni umumlashtirish va umumlashtirish kerak.

Taqdimot oxirida natijalarning amaliy ahamiyati, ularni amaliyotga tatbiq etish yoki o'qitishda foydalanish imkoniyatlarini aks ettirish kerak.

15.2 Hisobot taqdimotning cheklangan vaqti uchun mo'ljallangan va taqdimot (tarqatma material) bilan uzviy bog'liqdir.

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

15.3 Taqdimot (tarqatma material) - bu hisobot bilan bevosita bog'liq bo'lgan maxsus dasturlar (masalan, Microsoft PowerPoint) yordamida tayyorlangan vizual raqamli, jadvalli va illyustrativ material.

15.4 Taqdimot uchun zarur illyustrativ material tanlanadi, uni ham ish matnidan, ham ilovalardan olish mumkin. Bu jadvallar, rasmlar, diagrammalar, diagrammalar, formulalar va boshqalar bo'lishi mumkin. Jadvallar noqulay bo'lmasligi kerak, raqamlar haddan tashqari batafsil bo'lmasligi kerak, formulalar aniq bo'lishi kerak.

Materialda hisobotda keltirilgan barcha tezislar aks ettirilishi kerak.

15.5 Taqdimot ikki shaklda ko'rsatilishi mumkin:

proyektor yordamida va stendda;

komissiyaning har bir a'zosi uchun qog'oz nusxa ko'rinishidagi tarqatma materiallardan foydalanish.

Taqdimot hajmi 8 dan 12 slaydgacha bo'lishi mumkin.

15.6 Hisobot faqat ko'rib chiqilayotgan masalaning mohiyatini, minimal sonli ma'lumotlarni, maxsus nomlarni, o'tkazmalarni o'z ichiga olishi kerak.

Hisobot loyiha (ish) bilan bir xil mantiqiy sxema bo'yicha tuzilgan, ya'ni: kirish qismi, asosiy qism va xulosalar. Kirish qismida ishning dolzarbligi va maqsadi, asosiy qismida ko'rib chiqilayotgan mavzu to'liq ochib berilishi kerak. Xulosalar qisqa va aniq bo'lishi kerak va

1-2 jumlada qo'yilgan muammolarni hal qilish bo'yicha tavsiyalarni ko'rib chiqing.

15.7 Birinchisi, loyiha (ish) mavzusi va ijrochining ma'lumotlari, ya'ni: familiyasi, ismi, otasining ismi, guruhi, mutaxassisligi (yo'nalishi) bilan slayd bo'lishi kerak. Ilmiy maslahatchini ko'rsatish maqsadga muvofiqdir.

15.8 Kurs loyihasi (ish) va FQP elektron shaklda tayyorlangan va raqamli tashuvchiga (masalan, CD / DVD) yozib olingan taqdimot bilan birga arxivga topshiriladi.

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

Ilova A

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

Ilova B

(fakultet nomi)

(bo'lim nomi)

____________ ________________

IZOH

fan (modul) bo'yicha kurs loyihasiga (ishiga) __

(o‘quv fanining nomi (modul))

mavzu bo'yicha ______________________________________________________________________

_____

_______________________

______________________________

Yo'nalish / mutaxassislik, profil / mutaxassislik:

___________ _________________________________________________________________

yo'nalish kodi yo'nalish nomi (mutaxassislik)

________________________________________________________________________________

profil nomi (mutaxassisligi)

Kurs loyihasining (ishning) belgilanishi _________________________ Guruh ________

Rostov-na-Donu

Ilova B

ROSSIYA FEDERASİYASI TA'LIM VA FAN VAZIRLIGI

FEDERAL DAVLAT BUJJETLI OLIY KASB-TA'LIM TA'LIM MASSASASI

"DON DAVLAT TEXNIK UNIVERSITETI" (DSTU)

Fakultet ________________________________________________________________

(fakultet nomi)

Bo'lim _________________________________________________________

(bo'lim nomi)

Bosh Bo'lim "______________"

____________ ________________

IZOH

mavzu bo'yicha dissertatsiya loyihasiga (ishiga):

___________________________________________________________________________

___________________________________________________________________________

___________________________________________________________________________

__________________________

(imzo, sana)

Diplom loyihasini belgilash ______________________

Guruh ______________

Yo'nalish (mutaxassislik) ___________

___________________________________

(Ism)

Loyiha (ish) menejeri

____________________________

(imzo, sana)

(lavozim, I.O.F.)

Bo'lim maslahatchilari:

_______________________________

_____________________

(bo'lim nomi)

(imzo, sana)

(lavozim, I.O.F.)

_______________________________

_____________________

(bo'lim nomi)

(imzo, sana)

(lavozim, I.O.F.)

Norm nazorati

_____________________

(imzo, sana)

(lavozim, I.O.F.)

Rostov-na-Donu

Kurs loyihalari (ishlari) va bitiruv malakaviy ishlarini ro'yxatdan o'tkazish qoidalari va mazmuniga qo'yiladigan talablar - 09.1.

Kompyuter dasturlari dasturlash hujjatlarining yagona tizimi (ESPD) talablariga muvofiq tuzilgan. ESPD - dasturiy hujjatlarni loyihalash, mazmuni, tuzilishi qoidalarini belgilaydigan GOSTlar to'plami.
Ushbu usul ESPD dan parchalarni o'z ichiga oladi. To'liq ma'lumotni to'g'ridan-to'g'ri GOSTlardan olish mumkin.

Dasturni loyihalashning qisqacha algoritmi

Qisqacha dasturni loyihalash algoritmi va dastur hujjatlarining turlari rasmda ko'rsatilgan. Ro'yxatdan o'tish jarayoni quyida batafsilroq tavsiflanadi.

Dastur hujjatini ro'yxatdan o'tkazish

Dastur hujjati - dasturlarni ishlab chiqish, ishlab chiqarish, texnik xizmat ko'rsatish va ishlatish uchun zarur bo'lgan ma'lumotlarni o'z ichiga olgan hujjat.

Har bir individual dastur hujjati GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604 (barcha ESPD hujjatlari uchun umumiy) talablariga muvofiq tuzilgan. ushbu GOSTlarning batafsil tavsifi quyida keltirilgan) va ma'lum bir dastur hujjati uchun GOST.

Dastur hujjatlariga umumiy talablar. GOST 19.105 - 78

Chop etilgan dastur hujjatlariga qo'yiladigan talablar. GOST 19.106 - 78

GOST 19.106-78 bosma bajarish usuli uchun dasturiy hujjatlarni bajarish qoidalarini belgilaydi.

Shuni ta'kidlash kerakki, ushbu GOST "Dastur matni" dasturiy hujjatiga taalluqli emas.

Dastur hujjati materiallari quyidagi ketma-ketlikda bo'lishi kerak:

  • Sarlavha qismi:
    • tasdiqlash varaqasi (hujjat varaqlarining umumiy soniga kiritilmagan);
    • sarlavha sahifasi (hujjatning birinchi sahifasi);
  • Axborot qismi:
    • izoh;
    • tarkib varaqasi;
  • Asosiy qism:
    • hujjat matni (rasmlar, jadvallar va boshqalar bilan);
    • ilovalar;
    • atamalar ro'yxati, qisqartmalar ro'yxati, raqamlar ro'yxati, jadvallar ro'yxati, mavzu ko'rsatkichi, ma'lumotnomalar ro'yxati;
    • o'zgarishlarni ro'yxatga olish qismi:
    • ro'yxatga olish varaqasini o'zgartirish.

Annotatsiya dasturning nashrini ko'rsatadi, hujjatning maqsadi va mazmunini qisqacha tavsiflaydi. Agar hujjat bir necha qismdan iborat bo'lsa, izohda qismlarning umumiy soni ko'rsatiladi. Hujjat mazmuni izohdan keyin alohida (raqamlangan) varaq(lar)ga joylashtiriladi, “MAZMUNI” sarlavhasi bilan ta’minlanadi, bo‘lim sifatida raqamlanmaydi va hujjatning umumiy varaqlari soniga kiritiladi.

Matnni formatlash:

  • Dastur hujjati varaqning bir tomonida, ikki oraliqda bajariladi; bir yoki bir yarim oraliqda ruxsat etiladi.
  • Izoh "ANNOTATION" sarlavhasi bilan alohida (raqamlangan) sahifaga joylashtiriladi va bo'lim sifatida raqamlanmaydi.
  • Bo'lim sarlavhalari bosh harf bilan yoziladi va matnning chap va o'ng chegaralariga nisbatan simmetrik tarzda joylashtiriladi.
  • Kichik bo'limlar sarlavhalari kichik harflar bilan paragraf bilan yoziladi (birinchi bosh harfdan tashqari).
  • Sarlavhalarda so'zlarni tire qo'yish mumkin emas. Sarlavha oxiriga nuqta qo'ymang.
  • Sarlavha va keyingi matn, shuningdek bo'lim va kichik bo'lim sarlavhalari orasidagi masofa quyidagilarga teng bo'lishi kerak:
    • hujjatni mashinkada yozishda bajarishda - ikki oraliq.
  • Matni oldingi bo'lim matni bilan bir sahifada yozilgan bo'limlar va bo'limlar uchun matnning oxirgi qatori va keyingi sarlavha o'rtasidagi masofa teng bo'lishi kerak:
    • hujjatni mashinada yozishda bajarishda - uchta matn terish oralig'i.
  • Bo'limlar, kichik bo'limlar, bandlar va kichik bandlar arab raqamlari bilan nuqta bilan raqamlanishi kerak.
  • Bo'lim ichida ushbu bo'limga kiritilgan barcha bo'limlar, bandlar va kichik bandlar uchun doimiy raqamlash bo'lishi kerak.
  • Bo'limlarni raqamlash bo'limning raqamini va ushbu bo'limga kiritilgan bo'limning tartib raqamini nuqta bilan ajratilgan (2.1; 3.1 va boshqalar) o'z ichiga oladi.
  • Agar bo'limlar va bo'limlar mavjud bo'lsa, band va kichik bandning tartib raqami (3.1.1, 3.1.1.1 va boshqalar) nuqtadan keyin kichik bo'lim raqamiga qo'shiladi.
  • Hujjat matni qisqa, tushunarli bo'lishi kerak, noto'g'ri talqin qilish ehtimolini istisno qiladi.
  • Atamalar va ta'riflar bir xil bo'lishi va belgilangan standartlarga mos kelishi kerak, ular yo'q bo'lganda - ilmiy va texnik adabiyotlarda umumiy qabul qilingan va atamalar ro'yxatida keltirilgan.
  • Hujjat matniga kerakli tushuntirishlar izohlar bilan tuzilishi mumkin.
  • Izoh shriftning yuqori cheti darajasida joylashgan qavsli raqam bilan belgilanadi, masalan: "chop etish qurilmasi2) ..." yoki "qog'oz5)".
  • Agar izoh alohida so'zga tegishli bo'lsa, izoh belgisi to'g'ridan-to'g'ri ushbu so'zning yoniga qo'yiladi, lekin agar u butun gapga tegishli bo'lsa, u holda gap oxirida. Izoh matni sahifaning oxiriga joylashtiriladi va asosiy matndan sahifaning chap tomoniga chizilgan 3 sm chiziq bilan ajratiladi.
  • Rasmlar, agar ushbu hujjatda bir nechta bo'lsa, butun hujjat bo'ylab arab raqamlari bilan raqamlangan.
  • Hujjatdagi formulalar, agar bir nechta bo'lsa, arab raqamlari bilan raqamlanadi, raqam varaqning o'ng tomonida, formulalar darajasida qavs ichida joylashtiriladi.
  • Formulaga kiritilgan belgilar va raqamli koeffitsientlarning ma'nosi to'g'ridan-to'g'ri formula ostida berilishi kerak. Har bir belgining ma'nosi formulada berilgan tartibda yangi satrda chop etiladi. Shifrni ochishning birinchi qatori "qaerda" so'zi bilan boshlanishi kerak, undan keyin ikki nuqta qo'yilmaydi.
  • Dastur hujjatlarida standartlarga (korxona standartlari bundan mustasno), texnik shartlarga va boshqa hujjatlarga (masalan, davlat nazorati organlarining hujjatlari, SSSR Gosstroy qoidalari va normalari) havolalarga ruxsat beriladi. Standartlar va spetsifikatsiyalarga murojaat qilganda, ularning belgilanishini ko'rsating.
  • Hujjatga umuman yoki uning bo'limlariga havola qilish kerak (hujjatning nomi va nomi, bo'lim yoki arizaning raqami va nomi ko'rsatilgan). Bo'lim yoki ilovaga qayta murojaat qilganda faqat raqam ko'rsatiladi.
  • Matn va jadvallarga eslatmalarda faqat ma'lumotnoma va tushuntirish ma'lumotlari ko'rsatilgan.
  • Bitta eslatma raqamlanmagan. "Eslatma" so'zidan keyin nuqta qo'ying.
  • Bir nechta eslatmalar ketma-ket arab raqamlari bilan nuqta bilan raqamlanishi kerak. “Eslatma” so‘zidan keyin ikki nuqta qo‘yiladi.
  • Matndagi so'zlarning qisqartmasi va rasmlar ostidagi izohlarga yo'l qo'yilmaydi.
  • Tasvirlangan material, jadvallar yoki yordamchi matn qo'shimchalar shaklida berilishi mumkin.
  • Har bir ilova yangi sahifadan boshlanib, yuqori o‘ng burchakda “ILOVA” so‘zi ko‘rsatilgan va matnga simmetrik ravishda bosh harflar bilan yozilgan mavzuli sarlavhaga ega bo‘lishi kerak.

GOSTda maydonlar, sahifalash joylari va shifr ko'rsatilgan namuna varag'i mavjud.