Наші послуги
Чим ми можемо вам допомогти
Консультації та рецензії
Розробка технічної документації на продукцію для державних потреб
Розробка технічної документації на прикладні сервіси
Розробка документації на комерційні продукти
впровадження DITA
Технічний переклад
стандарти
ЕСКД (ГОСТ 2)
КСАС (ГОСТ 34)
ISO / IEC
предмети
пристрої
програми
комплекси
платформи
процеси
системи
інфраструктури
документи
інструкції
по розгортанню
по експлуатації КТС
технологічні
описи
програми
системи
мови
керівництва
адміністратора
оператора
користувача
по експлуатації
програміста
сист. адміністратора
Інші
довідкова система
формуляр системи
Єдина система програмної документації (ЕСПД) - вітчизняний комплекс стандартів на програмну документацію. У професійному просторіччі його ще називають «дев'ятнадцятим гостом». що не зовсім правильно, оскільки мова йде не про один, а приблизно про 30 різних нормативно-технічних документах.
В основному стандарти ЕСПД містять вимоги до складу, змісту та оформлення документів, що описують програму на різних стадіях її життєвого циклу. Крім того, кілька документів присвячено порядку зберігання та оновлення документації.
Стандарти ЕСПД практично позбавлені методичної складової. Вони не пояснюють розробнику, як треба писати документацію, щоб вона вийшла корисною, зрозумілою, інформативною, зручною і т. Д. Вони дають тільки перелік типів документів і список розділів першого рівня для кожного з них. Правда, про кожний розділ сказано, які відомості повинні бути в ньому викладені.
Стандарти ЕСПД були прийняті в кінці 70-х років і дійшли до нас у вигляді, близькому до первісного. У них відображена практика роботи відомчих обчислювальних центрів, де експлуатувалися великі ЕОМ. Взаємодія людини з комп'ютерною системою тоді було побудовано зовсім не так, як тепер, і здійснювалося через громіздкі пульти, перфокарти і роздруківки, а для «простих смертних», які вирішують прикладні завдання, ще й за посередництва кваліфікованого персоналу. Чи треба довго пояснювати, наскільки ці стандарти до теперішнього часу застаріли? Досить сказати, що їм невідомі такі поширені сьогодні документи, як керівництво користувача і керівництво адміністратора.
І все-таки ними продовжують активно користуватися. Формально «дев'ятнадцятого» є сучасна альтернатива. Переведені на російську мову і прийняті в Росії на правах національних деякі стандарти ISO / IEC в області системної і програмної інженерії. Але великі, в тому числі, державні замовники переходити на них не поспішають. Це можна пояснити їх відсталістю (або вірністю традиції, як вам більше подобається), але лише частково.
Справа в тому, кожен стандарт ЕСПД при невеликому (сторінки три максимум) обсязі представляє собою набір досить формальних і тому легко перевіряються вимог до документа або разом з комплектом документації. Строго кажучи, це не заважає розробнику документації писати правильно оформлені дурниці. Але оскільки ЕСПД чітко визначає, з чого повинен складатися і як повинен виглядати результат, ми можемо, принаймні, відразу відхилити пачку паперу, яка в ці рамки не вписується. Що істотно спрощує завдання здачі-приймання документації як для замовника, так і для виконавця.
Стандарти ISO / IEC, навпаки, містять багато розумних правил змістовного характеру, але складно уявити собі процедуру їх формальної перевірки. Втім, ніхто не заважає застосовувати обидва ряди стандартів одночасно, благо, вони стосуються різних аспектів документування і один одному практично не суперечать.