Кіріспе

Инженерлік құжаттама түрі Жүйелік инженерия мен бағдарламалық жасақтама инженериясындағы интерфейсті басқару құжаты (ICD) жоба үшін жасалған барлық интерфейс ақпаратының (суреттер, диаграммалар, кестелер және мәтіндік ақпарат) тізімін ұсынады. Негізгі интерфейс құжаттарында жүйелер арасындағы немесе жүйеге немесе жүйеге арналған интерфейс немесе интерфейстер туралы егжей-тегжейлі мәліметтер мен сипаттама беріледі.

Сипаттамалары

Қолданбалық бағдарламалау интерфейсі - бағдарламалық жүйе үшін интерфейстің бір түрі, ол интерфейс арқылы жүйемен қамтамасыз етілген функциялар мен қызметтерге қалай қол жеткізуге болатынын сипаттайды. Егер жүйе өндіруші басқалардың жүйелерді пайдалануын қаласа, ICD және интерфейс спецификациялары (немесе олардың баламасы) пайдалы инвестиция болып табылады. ICD тек интерфейстің нақты құжаттамасын ғана сипаттауы керек, оны қосылу үшін пайдаланатын жүйелердің сипаттамаларын емес. Бұл жүйелердің функциясы мен логикасы қажеттілігіне қарай олардың өз талаптарына және жобалау құжаттарына сипатталуы тиіс. Осылайша, тәуелсіз командалар басқа жүйелердің интерфейс арқылы жіберілетін деректер мен сигналдарға қалай әсер ететінін ескермей, көрсетілген интерфейсті пайдаланатын байланыс жүйелерін жасай алады. Мысалы, ICD және оған байланысты интерфейс құжаттамасына өлшем, формат және деректермен өлшенетін нәрсе туралы ақпарат қамтылуы керек, бірақ кез-келген пайдаланушының мақсатты пайдалануындағы деректердің түпкілікті мағынасы болмауы керек. Қалыпты түрде анықталған интерфейс бір командаға қарама-қарсы жақты қарапайым байланыс симуляторымен симуляциялау арқылы интерфейсті іске асыруын сынауға мүмкіндік береді. Интерфейстің екінші жағындағы жүйенің бизнес-логикасын білмеу басқа жүйе өзінің бизнес-ережелері мен логикасын өзгерткенде бұзылып кетпейтін жүйені әзірлеуге мүмкіндік береді. (Қосымша интерфейс талаптарының спецификациясында шекті мөлшерлерді немесе салауаттылықты тексеруден аулақ болу керек.) Осылайша, жақсы модульдік және абстракциялық, оңай күтіп-ұстау және кеңейту мүмкіндігіне қол жеткізіледі.

Сын

Талаптар құжаттамасын және жүйелік инженерияны сынға алушылар көбінесе құжаттамаға тым көп мән берілгеніне шағымданады. ICD-лер көбінесе құжатпен басқарылатын жобаларда болады, бірақ айнымалы жобаларда да пайдалы болуы мүмкін (бірақ нақты аталмаған). МКК тек мәтіндік құжат болуы шарт емес. Бұл кіріс пен шығудың (эволюцияланатын) кестесі, әрбір ішкі жүйені DB көрінісі ретінде көрсететін динамикалық деректер қоры, өзара іс-қимыл диаграммаларының жиынтығы және т.б. болуы мүмкін. ICD-лер көбінесе субжүйелер уақытында асинхронды түрде жасалатын жерлерде қолданылады, өйткені олар әр түрлі субжүйе жобалау топтары арасында субжүйелер интерфейстері туралы ақпаратты жеткізудің құрылымдалған тәсілін ұсынады.