Программаны құжаттау

Программаны әзірлеу: техникалық тапсырмадан құжаттауға дейін

Программаны әзірлеу бірнеше өзара байланысты кезеңнен тұрады. Әр кезеңнің өз мақсаты бар: талаптарды нақтылау, шешімді жобалау, алгоритмдерді сипаттау, деректерді дұрыс ұйымдастыру және нәтижені сапалы құжаттау. Төменде осы тақырыптардың негізгі ұғымдары жүйеленіп берілген.

Негізгі назар аударатын бағыттар

  • Техникалық тапсырманы (ТТ) әзірлеу және келісу.
  • Техникалық жобалау кезеңінде шешім архитектурасын анықтау.
  • Алгоритмдердің құрылымдық сызбасын (блок-схема) құрастыру.
  • Берілгендерді ұйымдастыру: құрылымдар, типтер және сақтау тәсілдері.
  • Программаны құжаттау және бекітілген құжат түрлерін сақтау.

Техникалық тапсырма және техникалық жобалау кезеңі

Техникалық тапсырма (ТТ)

Техникалық тапсырма — жобаның негізі. Онда бағдарламаның мақсаты, функционалдық талаптар, шектеулер, кіріс/шығыс деректері, сапа көрсеткіштері және қабылдау критерийлері нақты жазылады.

ТТ неғұрлым анық әрі өлшенетін талаптарға негізделсе, кейінгі кезеңдерде қателік пен қайта жасау соғұрлым азаяды.

Техникалық жобалау

Бұл кезеңде бағдарламаның жалпы құрылымы белгіленеді: модульдер, олардың өзара байланысы, деректер ағындары, интерфейстер, өңдеу логикасы және есептеу тәсілдері.

Жобалау нәтижесі — іске асыруға дайын, логикалық тұрғыдан толыққанды шешім сипаттамасы.

Алгоритмдердің құрылымдық сызбасы және деректерді ұйымдастыру

Алгоритмдердің құрылымдық сызбасын өңдеу

Блок-схема алгоритмді көрнекі түрде ұсынуға көмектеседі: тармақталу, циклдер, шарттар, енгізу/шығару және өңдеу қадамдары айқын көрінеді. Бұл талдау мен тестілеуді жеңілдетеді.

  • Айқындық

    Логика түсінікті және тексеруге ыңғайлы болады.

  • Қателерді ерте табу

    Күрделі жерлерді код жазбай тұрып анықтауға мүмкіндік береді.

Берілгендерді ұйымдастыру

Деректерді дұрыс ұйымдастыру — өнімділік пен сенімділіктің негізгі факторы. Мұнда деректер типтері, массивтер, жазбалар (құрылымдар), файлдар, сондай-ақ деректерді сақтау және өңдеу тәсілдері қарастырылады.

Дұрыс таңдалған деректер құрылымы уақытты да, жадыны да үнемдейді және кодты қолдауды жеңілдетеді.

Программаны құжаттау және құжаттаудың бірлік жүйесі

Құжаттау не үшін қажет?

Құжаттау бағдарламаны пайдалану, сүйемелдеу және дамыту үшін қажет. Әсіресе бекітілген (мақұлданған) құжат түрлерін сақтау командалық жұмыста бірізділік пен түсініктілікті қамтамасыз етеді.

Техникалық құжаттар

Жүйе құрылымы, интерфейстер, модульдер сипаттамасы.

Пайдаланушы құжаттары

Нұсқаулық, орнату және жұмыс істеу тәртібі.

Сынақ құжаттары

Тест жоспарлары, сценарийлер, нәтижелер.

Құжаттаудың бірлік жүйесі құжаттардың атауы, құрылымы, белгіленуі және рәсімделу қағидаларын стандарттауға бағытталады.

Есептеу жүргізуге қолданылатын формулалар

Есептеулерде жиі қолданылатын математикалық функциялар мен амалдар төмендегідей топтарға бөлінеді. Оларды дұрыс таңдау дәлдік пен нәтижені түсіндіру тұрғысынан маңызды.

Дәрежеге шығару

  • Сандардың дәрежесі (мысалы, an).

Тригонометриялық және кері тригонометриялық функциялар

  • ctg x (котангенс)
  • arcsin x
  • arccos x
  • arcctg x

Логарифм

  • loga x (негізі a болатын логарифм)

Практикада функцияларды қолданғанда анықталу облысын, өлшем бірліктерін (мысалы, радиан/градус) және есептеу дәлдігін ескерген дұрыс.

Кездейсоқ шама: түсінігі және онымен жұмыс істеу

Кездейсоқ шама ұғымы

Кездейсоқ шама — мәні алдын ала нақты анықталмайтын, бірақ ықтималдық заңдылықтарына бағынатын шама. Ол дискретті (мәндері санаулы) немесе үздіксіз (мәндері аралықта) болуы мүмкін.

Кездейсоқ шамамен жұмыс істеуге арналған процедуралар мен функциялар

Бағдарламалауда кездейсоқ шамалармен жұмыс істеу үшін псевдокездейсоқ сандар генераторы және оларды түрлендіретін функциялар қолданылады. Мұндай құралдар модельдеу, статистикалық есептеулер және тестілеу кезінде жиі қажет болады.

Процедуралар

Инициализация (seed беру), генерацияны басқару және тізбектерді қайта өндіру сияқты әрекеттер.

Функциялар

Бірқалыпты үлестіруден мән алу және оны басқа үлестірулерге түрлендіру үшін қолданылатын есептеу функциялары.