Розробка керівництва програміста гост

Керівництво програміста відноситься до експлуатаційно-технічної документації. Розробляється такий документ для програмних продуктів. Призначений для ознайомлення програмістом, який буде вирішувати ті чи інші завдання, пов'язані з експлуатацією даної програми.

Там, де необхідно керівництво програміста?

Керівництво програміста необхідно в декількох випадках:

Програма, на яку складається документація, є середовищем розробки або бібліотеку.
Даний програмний продукт надає платформу для написання типових програм або систем.
Поширення продукту проходить спільно з програмним кодом або ж відбувається його постійна модифікація розробником.

За допомогою такого документа програмісту повинна бути представлена ​​вся необхідна інформація, яка може бути використана для створення власних програмних продуктів на базі даної системи. Інформація повинна бути надана в достатній кількості. Розробники ж за допомогою керівництва програміста мають можливість зафіксувати поточний стан продукту, що випускається, щоб уникнути плутанини при випуску нових продуктів.

До типових завдань такого документа належить:
Уточнення і пояснення фахівця поточного стану об'єктів, їх місцезнаходження і методів взаємодії. Також керівництво програміста повинно чітко розмежувати об'єкти, які спочатку внесені в систему, і об'єкти, які програміст створює самостійно.
Перерахування додаткових коштів розробки, які будуть потрібні при роботі, крім поточного продукту.
Уточнення вимог до системи, програмного середовища, а також коштів, необхідних для запуску.

Керівництво програміста повинно складатися грамотним професіоналом, обізнаний зі специфікою роботи конкретного програмного продукту і правилами складання подібних документів, що регламентуються по ГОСТ 19.504-79.

структура документа

Вимоги до заповнення посібників програміста встановлені відповідним державним стандартом. Структура такого документа повинна включати в себе:
Призначення і умови експлуатації програмного продукту.
Основні характеристики програми.
Методи звернення до програмного продукту.
Основна вхідна та вихідна інформація. Повідомлення.

На даний момент керівництво програмістів включає також різні схеми - схеми баз даних, діаграми класів, графи виклику функцій.