Comment rédiger un exemple de description de programme. Cours jeune combattant : Sur la préparation de la documentation du programme (documentation). Quel est le nom de votre produit ? Pourquoi est-ce nécessaire ?

La description du programme (GOST 19.402-78) doit contenir :

1 informations générales sur le programme - nom complet, désignation, ses applications possibles, ainsi que le logiciel nécessaire au fonctionnement du programme et les langages de programmation dans lesquels il est écrit. Par exemple:

Le programme "Poste de travail automatisé pour développeur de canons automoteurs" est destiné à... mis en œuvre sur... Le programme prend en charge...

Le programme est écrit dans un langage... à l'aide d'un compilateur...

2 Objectif fonctionnel– l'objet du programme et une description générale du fonctionnement du programme, ses principales caractéristiques, des informations sur les restrictions imposées à la portée du programme. Par exemple:

Le programme est conçu pour résoudre des problèmes... Le programme représente le cœur d'un poste de travail automatisé...

L'utilisateur a la possibilité..., implémenter..., exécuter..., analyser..., obtenir les résultats de l'analyse et du traitement..., construire... etc.

3 Description de la structure logique– méthodes utilisées, algorithmes du programme, description de la structure et de la logique du programme (en référence au texte du programme dans la langue source) et de ses composants, leurs fonctions et connexions entre eux, ainsi que la connexion des programme avec d’autres programmes. Le contenu de cette section doit être spécifique et basé sur le texte du programme.

Choix méthode de résolution consiste à déterminer la possibilité théorique de résoudre un problème et à trouver une règle formelle pour l'obtenir. Cette étape est mal formalisée, en raison de la très grande variété de problèmes et de méthodes permettant de les résoudre.

La méthode de résolution peut être présentée :

– sous la forme d'un système de formules (inconditionnelles ou conditionnelles) ;

– sous la forme d'un énoncé verbal de la séquence d'actions ;

- sous la forme de leurs combinaisons.

La description d'une méthode peut contenir des restrictions sur les données d'entrée imposées par la méthode.

Schémas d'algorithmes, de programmes, de données et de systèmes, donnés dans cette section, doivent utiliser la méthode d'exploration étape par étape. De plus, le niveau de détail doit être tel que les différentes parties du programme et les relations entre elles soient compréhensibles dans leur ensemble. En d'autres termes, vous devez d'abord décrire le schéma généralisé de l'algorithme, divisant le programme en blocs logiques, puis examiner en détail les schémas des algorithmes pour le fonctionnement de chacun de ces blocs. Les symboles et les règles de mise en œuvre des schémas sont déterminés par GOST 19.701-90 (Annexe B).

Le programme comprend les modules suivants :

– interface utilisateur ;

– module de détermination de chemins dans un graphe ;

– module de calcul de la fonction de transfert ;

– module de construction des caractéristiques d'amplitude et de fréquence de phase ;

– module de construction d'une réponse à une influence polynomiale ;

– éditeur de texte.

Le module d'interface est construit sur deux types de dialogues : un dialogue question-réponse et un dialogue de type menu. Le module d'interface contrôle...

Module de définitionchemins dans le graphique repose sur l'utilisation d'une méthode... C'est...

Module de calculfonction de transfert met en œuvre la méthode... etc.

Algorithmedéfinir des chemins dans le graphe a la forme : ...

4 Moyens techniques utilisés– types d’ordinateurs et d’appareils utilisés lors de l’exécution du programme. Par exemple:

Le programme fonctionne sur un ordinateur personnel (PC) de type IBM PC/AT. Pour travailler en mode interactif, un écran d'affichage, un clavier et une souris sont utilisés. Un adaptateur est requis pour prendre en charge le mode graphiqueSVGA. Les données d'entrée sont stockées sur des disquettes et/ou des disques durs. Le programme fonctionne sous le système d'exploitation...

– la méthode d'appel du programme depuis le support de stockage correspondant et les points d'entrée dans le programme, ainsi que le nom du module de démarrage, des informations sur l'utilisation de la RAM, la taille du programme et une description de l'ensemble de la procédure pour appeler et charger le système. Par exemple:

6 Données d'entrée– la nature, l'organisation et la préparation préliminaire des données d'entrée, leur format, leur description et leur méthode de codage.

La description de la structure des données d'entrée comprend une indication des types de données, des plages de leurs valeurs, des formats de présentation, etc.

Cette section doit également contenir une liste d'anomalies dans les données d'entrée (valeurs pour lesquelles la méthode de solution implémentée ne peut pas être utilisée) et les réactions du programme à celles-ci.

Les données d'entrée du programme sont un fichier texte décrivant la matrice d'incidence étendue du graphique du système étudié. Ce fichier a la structure suivante...

La méthode utilisée pour déterminer... ne peut pas être utilisée avec..., donc ces valeurs ne sont pas valides, et le programme y répond en affichant un message...

7 Imprimer– la nature et l'organisation des données de sortie, leur format, leur description et leur méthode de codage.

La description de la structure des données de sortie comprend une indication des types de données, des plages de leurs valeurs, des formats de présentation, etc.

Le résultat est :

– informations graphiques et textuelles affichées à l'écran (résultats de l'analyse du système) ;

– fichiers dans l'un des formats graphiques – copies de l'image des caractéristiques construites (réponse en fréquence, réponse en phase, etc.) ;

– fichiers texte – rapports sur les recherches menées au format... ;

– diagnostics de l'état du système et messages sur toutes les erreurs qui se produisent.

Selon les spécificités du programme, des sections supplémentaires peuvent être introduites.

Les programmes informatiques sont élaborés conformément aux exigences du Système unifié de documentation des programmes (USPD). Le DUME est un ensemble de GOST qui établissent les règles de conception, de contenu et de structure des documents du programme.
Ce guide pratique contient des extraits du DUME. Des informations complètes peuvent être obtenues directement auprès des GOST.

Bref algorithme de conception de programme

En bref, l'algorithme de conception du programme et les types de documents du programme sont présentés dans la figure. Le processus d'inscription est décrit plus en détail ci-dessous.

Préparation d'un document de programme

Document de programme - un document contenant les informations nécessaires au développement, à la production, à la maintenance et à l'exploitation des programmes.

Chaque document de programme individuel est rédigé conformément (communes à tous les documents DUME) aux exigences de GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 ( une description plus détaillée de ces GOST suit ci-dessous) et GOST pour un document de programme spécifique.

Exigences générales pour les documents du programme. GOST 19.105 - 78

Exigences relatives aux documents imprimés du programme. GOST 19.106 - 78

GOST 19.106-78 établit les règles d'exécution des documents de programme pour la méthode d'exécution imprimée.

Il est important de noter que ce GOST ne s'applique pas au document de programme « Texte du programme ».

Matériel du document de programme doit être dans l'ordre suivant:

• Partie titre :
  • feuille d'approbation (non incluse dans le nombre total de feuilles du document);
  • page de titre (première page du document);
• Partie informationnelle :
  • annotation;
  • table des matières;
• Partie principale :
  • texte du document (avec images, tableaux, etc.) ;
  • candidatures ;
  • liste de termes, liste d'abréviations, liste de figures, liste de tableaux, index thématique, liste de documents de référence ;
  • modifier la partie de journalisation :
  • modifier la fiche d'inscription.

L'annotation indique l'édition du programme et décrit brièvement le but et le contenu du document. Si le document est composé de plusieurs parties, le nombre total de parties est indiqué dans l'annotation. Le contenu du document est placé sur une ou plusieurs pages (numérotées) séparées après l'annotation, munies de l'en-tête « CONTENU », non numérotées en tant que section et incluses dans le nombre total de pages du document.

Formatage du texte :

• Le document de programme est exécuté sur une face de la feuille, à deux intervalles ; autorisé à un intervalle d'un ou un intervalle et demi.
• Le résumé est placé sur une page séparée (numérotée) avec le titre « RÉSUMÉ » et n'est pas numéroté comme une section.
• Les titres de section sont écrits en majuscules et placés symétriquement par rapport aux bordures droite et gauche du texte.
• Les titres de sous-sections sont écrits à partir du paragraphe en lettres minuscules (à l'exception de la première majuscule).
• La césure des mots dans les titres n'est pas autorisée. Il n'y a pas de point à la fin du titre.
• La distance entre le titre et le texte suivant, ainsi qu'entre les titres de section et de sous-section, doit être égale à :
  • lors de l'exécution d'un document par dactylographie - deux intervalles.
• Pour les sections et sous-sections dont le texte est écrit sur la même page que le texte de la section précédente, la distance entre la dernière ligne de texte et le titre suivant doit être égale à :
  • lors de l'exécution d'un document à l'aide d'une méthode dactylographiée - trois intervalles dactylographiés.
• Les sections, sous-sections, paragraphes et sous-paragraphes doivent être numérotés en chiffres arabes avec un point.
• Dans une section, il doit y avoir une numérotation continue pour tous les sous-paragraphes, paragraphes et sous-paragraphes inclus dans cette section.
• La numérotation des sous-sections comprend le numéro de section et le numéro d'ordre de la sous-section incluse dans cette section, séparés par un point (2.1 ; 3.1, etc.).
• S'il y a des sections et des sous-sections, le numéro d'ordre de l'article et du sous-article (3.1.1, 3.1.1.1, etc.) est ajouté au numéro de sous-section après le point.
• Le texte du document doit être court, clair, excluant toute possibilité de mauvaise interprétation.
• Les termes et définitions doivent être uniformes et conformes aux normes établies, et en leur absence, généralement acceptés dans la littérature scientifique et technique, et être indiqués dans la liste des termes.
• Les explications nécessaires au texte du document peuvent être fournies dans les notes de bas de page.
• Une note de bas de page est indiquée par un chiffre avec parenthèse placé au niveau de la ligne du bord supérieur de la police, par exemple : « périphérique d'impression2)... » ou « papier5) ».
• Si une note de bas de page fait référence à un seul mot, le signe de note de bas de page est placé directement à côté de ce mot, mais s'il fait référence à une phrase dans son ensemble, alors à la fin de la phrase. Le texte de la note de bas de page est placé en fin de page et séparé du texte principal par une ligne de 3 cm de long tracée sur le côté gauche de la page.
• Les illustrations, s'il y en a plusieurs dans un document donné, sont numérotées en chiffres arabes sur l'ensemble du document.
• Les formules dans un document, s'il y en a plusieurs, sont numérotées en chiffres arabes ; le numéro est placé sur le côté droit de la page, entre parenthèses au niveau de la formule.
• La signification des symboles et des coefficients numériques inclus dans la formule doit être indiquée directement sous la formule. La signification de chaque caractère est imprimée sur une nouvelle ligne dans l'ordre dans lequel ils sont donnés dans la formule. La première ligne de la transcription doit commencer par le mot « où », sans deux points après.
• Dans les documents du programme, les références aux normes (à l'exception des normes d'entreprise), aux spécifications techniques et à d'autres documents (par exemple, les documents des organismes de surveillance de l'État, les règles et règlements du Comité national de la construction de l'URSS) sont autorisées. Lorsqu'on fait référence aux normes et spécifications techniques, leur désignation est indiquée.
• Il convient de faire référence au document dans son ensemble ou à ses sections (en indiquant la désignation et le nom du document, le numéro et le nom de la section ou de l'annexe). Lors de la répétition des références à une section ou à une application, seul le numéro est indiqué.
• Les notes du texte et des tableaux indiquent uniquement des données de référence et explicatives.
• Un billet n'est pas numéroté. Après le mot « Note », mettez un point.
• Plusieurs notes doivent être numérotées dans l'ordre en utilisant des chiffres arabes avec un point. Après le mot « Note », mettez deux points.
• Les abréviations de mots dans le texte et les inscriptions sous les illustrations ne sont pas autorisées.
• Du matériel illustré, des tableaux ou des textes justificatifs peuvent être présentés sous forme d’annexes.
• Chaque candidature doit commencer sur une nouvelle page avec le mot « ANNEXE » indiqué dans le coin supérieur droit et comporter un en-tête thématique, écrit symétriquement au texte en lettres majuscules.

GOST contient un exemple de feuille qui indique les champs, les emplacements pour la numérotation des pages et le code.

Ce document est du type logiciel-opérationnel. S'applique à un programme, un complexe, un progiciel, un composant logiciel ou un système.
Public cible : personnes qui prennent les décisions concernant l'achat et la mise en service du programme. Le document contient des informations sur la fonctionnalité du programme et son champ d'application.

GOST et normes

La structure et la conception du document sont déterminées dans.
Partie informationnelle (annotations et contenu) conformément à.

Dans quels cas est-il nécessaire

Le document est nécessaire pour informer les utilisateurs et acheteurs potentiels de l'objectif du programme et des méthodes d'application. Plus adapté aux gestionnaires (spécialistes, administrateurs système) qui décident de manière indépendante d'acheter le programme et de le mettre en service.

Ils peuvent obtenir toutes les informations nécessaires à partir de ce document : une description du programme et de son application.

La description du programme et la description de la candidature indiquent :

Problèmes que le programme résout ;
Ressources dépensées pour le travail ;
Informations introductives ;
Données de sortie.

L'accent est mis sur la partie descriptive du programme, ses fonctions et son objectif. Dans une moindre mesure sur la description de l'application. Une description est faite spécifiquement sur les capacités du programme et les tâches qu'il résout, et non sur sa structure interne. Avec certaines fonctionnalités du programme, il est possible de combiner des sections ou d'en introduire de nouvelles (supplémentaires).

Structure de la description du programme (GOST 19.402-78) :

1. Informations générales.
2. Objectif fonctionnel du programme.
3. Description de la structure logique.
4. Moyens techniques utilisés.
5. Appelez et téléchargez.
6. Saisissez les données.
7. Empreinte.

Structure de la description de la demande (GOST 19.502-78) :

1. Objectif du programme.
2. Conditions d'utilisation.
3. Partie descriptive de la tâche.
4. Données d'entrée et de sortie.
5. applications (tableaux, illustrations, etc.).

Vous pouvez commander l'élaboration d'un document ou d'un ensemble complet de documentation logicielle.

Par décret du Comité d'État de l'URSS sur les normes du 18 décembre 1978 n° 3350, la date d'introduction a été fixée

du 01.01. 1980

1. Cette norme établit la composition et les exigences relatives au contenu du document de programme « Description du programme », défini par GOST 19.101-77.

La norme est entièrement conforme à ST SEV 2092-80.

2. La structure et la conception du document sont établies conformément à GOST 19.105-78.

La rédaction de la partie informationnelle (annotations et contenu) est obligatoire.

3. La description du programme doit contenir les sections suivantes :

• informations générales;
• objectif fonctionnel;
• description de la structure logique ;
• moyens techniques utilisés ;
• données d'entrée ;
• données de sortie.

Selon les caractéristiques du programme, il est possible d'introduire des sections supplémentaires ou de combiner des sections individuelles.

4. Dans la section « Informations générales », les éléments suivants doivent être indiqués :

• désignation et nom du programme;
• logiciel nécessaire au fonctionnement du programme ;
• langages de programmation dans lesquels le programme est écrit.

5. La section « Objectif fonctionnel » doit indiquer les classes de problèmes à résoudre et (ou) l'objectif du programme et des informations sur les restrictions fonctionnelles d'application.

6. Dans la section « Description de la structure logique », les éléments suivants doivent être indiqués :

• algorithme de programme ;
• méthodes utilisées;
• structure du programme avec une description des fonctions de ses composants et des connexions entre eux ;
• connexion du programme avec d'autres programmes.

La description de la structure logique du programme est réalisée en tenant compte du texte du programme dans la langue source.

3-6.(Édition modifiée, amendement n° 1).

7. La section « Outils techniques utilisés » doit indiquer les types d'ordinateurs et d'appareils électroniques utilisés lors de l'exécution du programme.

• méthode d'appel du programme à partir du support de stockage correspondant ;
• points d’entrée dans le programme.

Vous pouvez spécifier des adresses de téléchargement, des informations sur l'utilisation de la RAM et la taille du programme.

9. Dans la section « Données d'entrée », les éléments suivants doivent être indiqués :

• nature, organisation et préparation préliminaire des données d'entrée ;
• format, description et méthode de codage des données d'entrée.

10. Dans la section « Données de sortie », les éléments suivants doivent être indiqués :

• nature et organisation des données de sortie ;
• format, description et méthode de codage des données de sortie.

11. Il est permis d'illustrer le contenu des sections avec des exemples explicatifs, des tableaux, des diagrammes, des graphiques.

12. L'annexe à la description du programme peut contenir divers éléments qu'il est inapproprié d'inclure dans les sections de la description.

7-12.(Introduit en plus, amendement n° 1).

* Réédition (novembre 1987) avec modification n° 1, approuvée en septembre 1981 (IUS 11-81)

Informations générales.

Le programme s'appelle jane et est enregistré dans le fichier jane.dpr. Le programme utilise les modules auxiliaires main, new, dmData, about, respectivement enregistrés dans les fichiers main.pas, new.pas, about.pas, dmData.pas. Le programme est écrit dans le langage de programmation Delphi. Le programme utilise les données des tables de base de données otdel.db, sotrudnik.db, family.db, obrazovanie.db

Objectif fonctionnel.

Mise en place d'un graphique de dialogue.

En règle générale, l'interface entre l'utilisateur et l'ordinateur comprend un écran de contrôle, un clavier et une souris : c'est ce qui présente les informations à l'utilisateur et en reçoit de sa part. ,

En pratique, un programme écrit avec Delphi est accessible via une interface utilisateur graphique. L'interface graphique mise en œuvre par le programme d'application est une sorte de dialogue qui s'établit entre l'ordinateur et son utilisateur. En d'autres termes, une interface est la partie d'un programme qui, pour exécuter certaines fonctions, traduit les actions de l'utilisateur en une ou plusieurs requêtes et fournit un retour d'information à l'utilisateur en fonction de la séquence de ses actions.

L'utilisateur a la possibilité de sélectionner les fonctions du système à l'aide de menus à boutons et pictographiques. L'utilisateur voit devant lui le contenu de la base de données sous la forme d'un document écran. L'interaction avec l'utilisateur s'effectue via des formulaires écran. La mise en œuvre du graphe de dialogue est illustrée à la figure 17.

Figure 17. Arbre des formulaires d'écran

Description de la structure logique.

Le programme est événementiel. Lorsque vous cliquez sur un bouton, le programme reçoit un message et la procédure de gestion correspondante est appelée, qui traite cet événement. Les résultats du traitement peuvent être vus sur l’écran du moniteur. Par exemple : lorsque vous cliquez sur le bouton « Travail » dans le formulaire « Projet de diplôme », la procédure contenue dans le module Nouveau est appelée, ce qui masque le formulaire « Projet de diplôme », affiche le formulaire « Comptabilité du personnel » sur l'écran du moniteur. , et le contrôle est transféré au module principal.

Pour exécuter le programme, vous devez charger le shell Delphi sur votre ordinateur personnel et compiler le texte source du programme contenu dans le fichier jane.dpr. Appelez le fichier exe, puis travaillez avec lui. Avant de commencer les travaux, vous devez suivre la procédure d'autorisation (Figure 18).

Figure 18. Formulaire de saisie du mot de passe

Données d'entrée et de sortie.

Données d'entrée :

nom du département,

Nom du patron,

Nom complet des employés, poste,

date d'embauche,

lieu du dernier travail,

ancienneté à la date d'admission,

un signe d'éducation,

un signe d'avoir une famille,

nombre d'enfants

état civil,

dates de naissance,

type d'éducation,

forme d'éducation,

établissement d'enseignement,

date de fin,

spécialité.

Données de sortie : tous les résultats des actions de l'utilisateur lors de l'utilisation de bases de données sont affichés sur l'écran du moniteur ; ces résultats, affichés sous forme de base de données à l'écran, sont la sortie du programme. De plus, le résultat du travail avec cette base de données « Comptabilité du personnel » peut être la génération d'ordres et leur impression, ce qui facilite grandement le travail de l'utilisateur et élimine le besoin de rédiger manuellement des documents tels que des ordres de licenciement ou d'embauche d'employés et de leurs personnels. cartes.