NORME INTER-ÉTATS

Par décret du Comité d'État de l'URSS sur les normes du 12 janvier 1979 n° 74, la date d'introduction a été fixée

Édition avec amendement n° 1, approuvée en septembre 1981 (IUS 11-81).

Cette norme établit des exigences pour le contenu et la conception du document de programme « Manuel de l'opérateur », défini par .

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

1. DISPOSITIONS GÉNÉRALES

1.1. La structure et la conception du document de programme sont établies conformément à.

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

1.2. Le manuel de l'opérateur doit contenir les sections suivantes :

le but du programme ;

les conditions de mise en œuvre du programme ;

exécution du programme ;

messages à l'opérateur.

Selon les spécificités du document, il est possible de combiner des sections individuelles ou d'en introduire de nouvelles.

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

2.1. La section « Objectif du programme » doit contenir des informations sur l'objectif du programme et des informations suffisantes pour comprendre les fonctions du programme et son fonctionnement.

2.2. La section « Conditions d'exécution du programme » doit indiquer les conditions nécessaires à l'exécution du programme (composition minimale et (ou) maximale du matériel et des logiciels, etc.).

2.3. Dans la section « Exécution du programme », il doit y avoir : une séquence d'actions de l'opérateur qui assurent le chargement, le lancement, l'exécution et l'achèvement du programme, une description des fonctions, du format et des options de commande possibles avec lesquelles l'opérateur charge et contrôle l'exécution de le programme, ainsi que les réponses du programme à ces commandes.

2.2, 2.3. (Édition modifiée, amendement n° 1).

2.4. (Supprimé, amendement n° 1).

2.5. La section « Messages à l'opérateur » doit contenir les textes des messages émis lors de l'exécution du programme, une description de leur contenu et les actions de l'opérateur correspondantes (actions de l'opérateur en cas de panne, possibilité de redémarrer le programme, etc.).

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

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

2.7. Les annexes du manuel de l'opérateur peuvent inclure divers éléments qu'il n'est pas approprié d'inclure dans les sections du manuel.

(Introduit en plus, amendement n° 1).

Mis en vigueur par le décret du Comité d'État de l'URSS sur les normes du 12 janvier 1979 N 74

Norme interétatique GOST 19.505-79

"SYSTÈME UNIFIÉ DE DOCUMENTATION LOGICIELLE. MANUEL DE L'OPÉRATEUR. EXIGENCES DE CONTENU ET DE CONCEPTION"

Système unifié pour la documentation du programme. Guide d'utilisation. Exigences relatives au contenu et à la forme de présentation

Cette norme établit les exigences relatives au contenu et à la conception du document de programme « Manuel de l'opérateur », défini par GOST 19.101-77.

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

1. Dispositions générales

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

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

1.2. Le manuel de l'opérateur doit contenir les sections suivantes :

le but du programme ;

les conditions de mise en œuvre du programme ;

exécution du programme ;

messages à l'opérateur.

Selon les spécificités du document, il est possible de combiner des sections individuelles ou d'en introduire de nouvelles.

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

2.1. La section « Objectif du programme » doit contenir des informations sur l'objectif du programme et des informations suffisantes pour comprendre les fonctions du programme et son fonctionnement.

2.2. La section « Conditions d'exécution du programme » doit indiquer les conditions nécessaires à l'exécution du programme (composition minimale et (ou) maximale du matériel et des logiciels, etc.).

2.3. Dans la section « Exécution du programme », il doit y avoir : une séquence d'actions de l'opérateur qui assurent le chargement, le lancement, l'exécution et l'achèvement du programme, une description des fonctions, du format et des options de commande possibles avec lesquelles l'opérateur charge et contrôle l'exécution de le programme, ainsi que les réponses du programme à ces commandes.

2.2, 2.3. (Édition modifiée, amendement n° 1).

2.4. (Supprimé, amendement n° 1).

2.5. La section « Messages à l'opérateur » doit contenir les textes des messages émis lors de l'exécution du programme, une description de leur contenu et les actions de l'opérateur correspondantes (actions de l'opérateur en cas de panne, possibilité de redémarrer le programme, etc.).

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

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

2.7. Les annexes du manuel de l'opérateur peuvent inclure divers éléments qu'il n'est pas approprié d'inclure dans les sections du manuel.

(Introduit en plus, amendement n° 1).

GOST 19.505-79

NORME INTER-ÉTATS

UN SYSTÈME
DOCUMENTATION DU LOGICIEL

MANUEL DE L'OPÉRATEUR

EXIGENCES DE CONTENU
ET CONCEPTION

Édition (janvier 2002) avec modification n° 1, approuvée en septembre 1981 (IUS 11-81).

Par décret du Comité d'État de l'URSS sur les normes du 12 janvier 1979 n° 74, la date d'introduction a été fixée

01.01.80

Cette norme établit des exigences pour le contenu et la conception du document de programme « Manuel de l'opérateur », défini par GOST 19.101-77.

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

1. DISPOSITIONS GÉNÉRALES

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

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

1.2. Le manuel de l'opérateur doit contenir les sections suivantes :

le but du programme ;

les conditions de mise en œuvre du programme ;

exécution du programme ;

messages à l'opérateur.

Selon les spécificités du document, il est possible de combiner des sections individuelles ou d'en introduire de nouvelles.

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

2.1. La section « Objectif du programme » doit contenir des informations sur l'objectif du programme et des informations suffisantes pour comprendre les fonctions du programme et son fonctionnement.

2.2. La section « Conditions d'exécution du programme » doit indiquer les conditions nécessaires à l'exécution du programme (composition minimale et (ou) maximale du matériel et des logiciels, etc.).

2.3. Dans la section « Exécution du programme », il doit y avoir : une séquence d'actions de l'opérateur qui assurent le chargement, le lancement, l'exécution et l'achèvement du programme, une description des fonctions, du format et des options de commande possibles avec lesquelles l'opérateur charge et contrôle l'exécution de le programme, ainsi que les réponses du programme à ces commandes.

2.2, 2.3. (Édition modifiée, amendement n° 1).

2.4.(Supprimé, amendement n° 1).

2.5. La section « Messages à l'opérateur » doit contenir les textes des messages émis lors de l'exécution du programme, une description de leur contenu et les actions de l'opérateur correspondantes (actions de l'opérateur en cas de panne, possibilité de redémarrer le programme, etc.).

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

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

2.7. Les annexes du manuel de l'opérateur peuvent inclure divers éléments qu'il n'est pas approprié d'inclure dans les sections du manuel.

(Introduit en plus, amendement n° 1).

G O SUD A R S T V E N N Y S T A N D A R T S O Y W A S S R

Système unifié de documentation du programme	GOST 19.505-79* (ST SEV 2096-80)
MANUEL DE L'OPÉRATEUR. EXIGENCES RELATIVES AU CONTENU ET À LA CONCEPTION
Système uni pour la documentation du programme. Guide d'utilisation. Exigences relatives au contenu et à la forme de présentation

Par résolution du Comité d'État des normes du Conseil des ministres de l'URSS du 12 janvier 1979 n° 74, la date d'introduction a été fixée

du 01.01. 1980

Cette norme établit des exigences pour le contenu et la conception du document de programme « Manuel de l'opérateur », défini par GOST 19.101-77.

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

1. DISPOSITIONS GÉNÉRALES

1.1. La structure et le format du document sont établis conformément à GOST 19.105-78.

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

1.2. Le manuel de l'opérateur doit contenir les sections suivantes :

le but du programme ;

les conditions de mise en œuvre du programme ;

exécution du programme ;

messages à l'opérateur.

Selon les spécificités des documents, il est possible de combiner des sections individuelles ou d'en introduire de nouvelles.

2.1. La section « Objectif du programme » doit contenir des informations sur l'objectif du programme et des informations suffisantes pour comprendre les fonctions du programme et son fonctionnement.

2.2. La rubrique « Conditions d'exécution du programme » doit indiquer les conditions nécessaires à l'exécution du programme (composition minimale et (ou) maximale de matériel et de logiciels, etc.).

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

2.3. La section « Exécution du programme » doit indiquer la séquence d'actions de l'opérateur qui assurent le chargement, le lancement, l'exécution et la fin du programme, une description des fonctions, du format et des options de commande possibles avec lesquelles l'opérateur charge et contrôle l'exécution du programme, ainsi que ainsi que les réponses du programme à ces équipes.

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

2.4. La section « Messages à l'opérateur » doit contenir les textes des messages émis lors de l'exécution du programme, une description de leur contenu et les actions de l'opérateur correspondantes (actions de l'opérateur en cas de panne, possibilité de redémarrer le programme, etc.).

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

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

2.6. Les annexes du manuel de l'opérateur peuvent inclure divers éléments qu'il n'est pas approprié d'inclure dans les sections du manuel.

(Introduit en plus, amendement n° 1).

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

Comment rédiger un manuel d'utilisation selon GOST 19.505-79 ?

Créé le 16/02/2010 19:41:18

Le manuel de l'opérateur selon GOST 19.505-79 est présenté ci-dessous.

et installé conformément à.

La rédaction de la partie informationnelle (annotations et) est obligatoire [de la clause 1.1 de GOST 19.505-79]

Dans l'annotation, indiquez la phrase suivante : « Ce manuel s'applique exclusivement au programme et ne remplace pas la littérature éducative, de référence, les manuels du fabricant et d'autres sources couvrant le travail avec le système d'exploitation. » Il est permis de créer une sous-section « Objectif du manuel » ou « Recommandations pour ».

Objectif du programme

Dans la section « Objet du programme », des informations sur l'objectif du programme et suffisantes pour cela doivent être indiquées [de la clause 2.1 de GOST 19.505-79]

"...des informations sur l'objet du programme doivent être indiquées." Les informations sur l'objet du programme sont énoncées dans le document fondamental - c.

Objectif fonctionnel

Le but du programme est de fournir des opportunités au format RTF.

Objectif opérationnel

Le programme doit être utilisé dans les services spécialisés des sites clients.

Les utilisateurs du programme doivent être des employés des services spécialisés des installations du client.

Composition des fonctions

Le programme offre la possibilité d'exécuter les fonctions suivantes :

1. Fonctions de création d'un nouveau (vide) ;
2. Fonctions d'ouverture (chargement) d'un fichier existant ;
3. Fonctions d'édition d'un fichier ouvert (ci-après dénommé le fichier actuel) en remplaçant, supprimant un fichier à l'aide de périphériques d'entrée standard ;
4. Fonctions d'édition du fichier actuel à l'aide du presse-papiers ;
5. Fonctions pour enregistrer le fichier avec le nom d'origine ;
6. Fonctions pour enregistrer un fichier avec un nom différent de celui d'origine ;
7. Fonctions d'envoi du contenu du fichier en cours par e-mail à l'aide d'un programme de messagerie client externe ;
8. Fonctions de sortie en chaîne (indices) ;
9. Fonctions du système d'aide en ligne ;
10. Fonctions d'affichage du programme, de la version du programme, des droits d'auteur et des commentaires du développeur.

Conditions d'exécution du programme

Dans la section «Conditions de mise en œuvre du programme», les conditions nécessaires à la mise en œuvre du programme doivent être indiquées (composition minimale et (ou) maximale, etc.) [de la clause 2.2 de GOST 19.505-79]

Nous créons les sous-sections correspondantes. Puisque le terme « matériel » semble démodé, nous le remplaçons par « technique ».

Conditions climatiques de fonctionnement

Les conditions climatiques dans lesquelles les caractéristiques spécifiées doivent être assurées doivent satisfaire aux exigences de leurs conditions de fonctionnement.

Composition minimale des moyens techniques

L'équipement technique doit comprendre un ordinateur personnel compatible IBM (), qui comprend :

1. Pentium-1000 avec une fréquence d'horloge de 10 GHz, rien de moins ;
2. carte mère avec FSB, GHz - 5, rien de moins ;
3. volume, Tb - 10, pas moins ;
4. et ainsi de suite…

Composants logiciels minimaux

Ceux utilisés par le programme doivent être représentés par une version localisée du système d'exploitation. Vous pouvez utiliser tel ou tel service pack.

Conditions requises pour le personnel (utilisateur)

Le nombre minimum de personnes requis pour faire fonctionner le programme doit être d'au moins 2 postes - un administrateur système et un utilisateur du programme -.

L'administrateur système doit avoir une formation supérieure spécialisée et le fabricant du système d'exploitation. La liste des tâches effectuées par l'administrateur système doit inclure :

1. la tâche d'entretien des moyens techniques ;
2. tâches d'installation (installation) et de maintenance – système d'exploitation ;
3. la tâche d’installer un programme.

L'utilisateur du programme (opérateur) doit avoir des compétences pratiques pour travailler avec le système d'exploitation.

Le personnel doit être certifié pour le groupe de qualification II en sécurité électrique (pour travailler avec des équipements de bureau).

Exécution du programme

La section « Exécution du programme » doit indiquer la séquence d'actions de l'opérateur qui assurent le lancement, l'exécution et l'achèvement du programme, une description des fonctions, du format et des options possibles avec lesquelles il charge et contrôle l'exécution du programme, ainsi que les réponses du programme à ces commandes [de la clause 2.3 GOST 19.505-79]

Automatiquement, à l'aide de nos doigts, nous créons des sous-sections :

Exécution du programme ;

Fin du programme.

Pendant Ô mais les programmes ont été réalisés séparément, le lancement a été réalisé séparément. Dans l’environnement actuel, le téléchargement et le lancement ont été combinés en un seul. La phrase clé de la sous-section « Exigences relatives au nombre et aux qualifications du personnel » de la spécification technique - « l'utilisateur du programme (opérateur) doit être capable de travailler avec l'interface utilisateur graphique du système d'exploitation » soulage l'auteur du obligation de décrire en détail comment charger et exécuter le programme... Le développeur n'est pas obligé d'indiquer à l'opérateur les techniques travaillant avec l'interface utilisateur graphique du système d'exploitation. Sauf dans les cas où le programme utilise des éléments d'interface qui ne sont pas natifs du système d'exploitation.

Exécution de la fonction pour créer un nouveau fichier (sans nom)

Si la fonction spécifiée est exécutée avec succès, une fenêtre s'affichera sur le bureau (voir Téléchargement et exécution du programme). Le programme est prêt à être saisi et modifié.

Remarque - Une fois le téléchargement et le lancement réussis, le programme créera automatiquement un nouveau fichier (sans nom).

L'approche est simple. Action - résultat, voir le schéma « action - résultat » en conjonction avec l'approche « faire ce que je dis ». Un résultat erroné est un message d'erreur.

Les partisans d'une attitude « amicale » envers l'utilisateur ont le droit d'intituler la sous-section, par exemple « Création d'un nouveau fichier ». Ni la lettre ni l'esprit ne l'empêchent. Ce document ne s'adresse pas directement à l'utilisateur. Il n'y a pas de « ouvrir », « cliquer », « spécifier », etc. Les tampons « doivent être ouverts », « doivent être pressés » et similaires sont utilisés (selon GOST 2.105-95).

Exécution d'une fonction pour ouvrir (charger) un fichier existant

Cette fonction peut être exécutée de l'une des manières suivantes :

En conséquence, une fenêtre s'affichera sur le bureau Ouvrir.

Remarque - Le programme offre la possibilité de télécharger des fichiers uniquement avec l'extension *.rtf.

Le fichier requis est sélectionné à l'aide de méthodes dont les informations détaillées sont fournies dans le manuel d'utilisation du système d'exploitation. La fonction est complétée en appuyant sur le bouton Ouvrir.

Si le fichier est ouvert avec succès (le programme exécute la fonction), une fenêtre avec le fichier ouvert (actuel) s'affichera sur le bureau. Principal fenêtre Le programme affichera le fichier actuel complet.

Il n’est pas sage d’assumer la responsabilité du respecté M. Torvalds et compagnie, encore moins de M. Gates. Ce manuel ne doit pas remplacer la littérature éducative, de référence, les manuels des fabricants de systèmes d'exploitation et d'autres sources d'informations couvrant l'utilisation de l'interface utilisateur graphique du système d'exploitation. Si l'utilisateur a besoin d'ouvrir le fichier à l'aide du système d'exploitation, laissez-le étudier le matériel et ainsi élargir ses horizons.

Exécuter la fonction d'édition du fichier actuel en saisissant, remplaçant, supprimant le contenu du fichier à l'aide de périphériques d'entrée

On suppose que les opérations sont non triviales, spécifiques, et il n'y a aucune information sur leur mise en œuvre dans le manuel d'utilisation du système d'exploitation et il ne peut y en avoir en principe. Par conséquent, des opérations simples et familières seront décrites en détail.

Modification du fichier actuel en saisissant du texte à partir de périphériques d'entrée

• en position de départ ;
• (dactylographie.

Pour marquer la position de départ de l'édition, déplacez le curseur vers la position de texte souhaitée et appuyez sur la touche gauche. Un curseur s'affichera à la position requise.

La séquence d'actions requise pour effectuer l'opération spécifiée comprend :

• texte, sujet ;
• saisir (saisir) du texte.

Pour mettre en surbrillance le texte à remplacer :

• déplacez le curseur vers la position de départ ;
• curseur sur la position finale du fragment.

Le fragment de texte sera surligné en couleur.

Modifiez le fichier actuel en supprimant le contenu à l'aide de périphériques d'entrée

La séquence d'actions requise pour effectuer l'opération spécifiée comprend :

• mettre en surbrillance le texte à supprimer ;

Des informations détaillées sur les méthodes de sélection d'un fragment de texte sont présentées dans le deuxième paragraphe du paragraphe Modification du fichier actuel en remplaçant le contenu à l'aide de périphériques d'entrée.

peut être effectué de l’une des manières suivantes :

1. en appuyant sur une touche Supprimer;
2. en appuyant sur un raccourci clavier Ctrl+X;
3. en appuyant sur une touche RetourEspace.

Exécution de la fonction d'édition du fichier actuel à l'aide du presse-papiers du système d'exploitation

Cette fonction comprend les opérations suivantes :

• opération de fichier (fragment) ;
• opération d'échange de contenu vers un fichier.

Effectuer une opération de copie (fragment) d'un fichier

La séquence d'actions requise pour effectuer l'opération spécifiée comprend :

• texte à copier ;

Des informations détaillées sur les méthodes de sélection d'un fragment de texte sont présentées dans le deuxième paragraphe du paragraphe Modification du fichier actuel en remplaçant le contenu à l'aide de périphériques d'entrée. Une fois le fragment sélectionné, le bouton de copie ressemblera à .

Remarque - S'il n'y a pas de texte (fragment) sélectionné, l'opération de copie ne peut pas être effectuée. Le bouton Copier n'est pas disponible et ressemble à un élément de menu Copie pas disponible.

À la suite de l'exécution de l'opération spécifiée, le fragment de texte sélectionné du fichier actuel sera placé dans le presse-papiers du système d'exploitation.

Effectuer une opération pour coller le contenu du presse-papiers dans un fichier

La séquence d'actions requise pour effectuer l'opération spécifiée comprend :

• une marque (indication) dans le texte du fichier courant de la position de départ de l'insertion ;
• coller le contenu du presse-papiers.

Remarque - S'il n'y a aucun contenu dans le presse-papiers, l'opération de collage ne peut pas être effectuée. Le bouton d'insertion est grisé et ressemble à un élément de menu Insérer pas disponible.

Pour marquer la position de départ de l'insertion, déplacez le curseur vers la position de texte souhaitée et appuyez sur la touche gauche. Un curseur s'affichera à la position requise.

Cette opération peut être effectuée de l'une des manières suivantes :

À la suite de l'exécution de l'opération spécifiée, un fragment de texte contenu dans le presse-papiers sera placé à la position requise dans le fichier actuel.

Exécution de la fonction pour enregistrer le fichier avec le nom d'origine

Cette fonction peut être exécutée de l'une des manières suivantes :

Probablement assez. Il ne sert à rien de dupliquer (en fait) les descriptions de la manière dont les fonctions typiques d'un programme sont exécutées dans un document.

Terminer le programme

La terminaison du programme est assurée par les outils standards du système d'exploitation.

Cette fonction peut être exécutée de l'une des manières suivantes :

Messages à l'opérateur

La section « Messages à l'opérateur » doit contenir des textes émis lors de l'exécution du programme, une description de leur contenu et les actions de l'opérateur correspondantes (actions de l'opérateur en cas de possibilité de redémarrage du programme, etc.) [de la clause 2.4 de GOST 19.505 -79]

Étant donné que le programme n'est pas un programme console (avec une interface en ligne), mais avec une interface utilisateur graphique, les messages texte classiques ne sont pas attendus. Les messages d'erreur apparaissent sous forme de fenêtres sur le bureau.

"description de leur contenu"

Erreur lors de l'enregistrement du fichier

Si vous essayez d'enregistrer un fichier sous le nom d'un fichier existant, un message d'erreur s'affichera sur le bureau du programme.

"et les actions de l'opérateur correspondantes"

Pour enregistrer un fichier sous le nom d'un fichier existant, cliquez sur le bouton Oui.

Pour enregistrer un fichier sous un nom différent de celui d'un fichier existant :

• appuie sur le bouton Non;
• répétez les instructions du paragraphe Exécution de la fonction de sauvegarde d'un fichier avec un nom différent de celui d'origine, en spécifiant un nom de fichier différent du nom du fichier existant.

À propos des illustrations

Il est permis d'illustrer le contenu des sections avec des exemples explicatifs, des tableaux, des graphiques [de la clause 2.5 de GOST 19.505-79]

Ce manuel de l'opérateur utilise (fenêtres) affichées sur le bureau à des fins d'illustration.

À propos des applications

Il est permis d'inclure divers éléments dans les annexes du manuel de l'opérateur qu'il est inapproprié d'inclure dans les sections du manuel [de la clause 2.6 de GOST 19.505-79]

Tout ce que votre cœur désire.

conclusions

Les déclarations de citoyens individuels selon lesquelles le 19e système de normes est désespérément dépassé et ne peut pas être utilisé pour le développement de programmes modernes dotés d'une interface utilisateur graphique, ainsi que pour le développement et la publication de produits logiciels de haute qualité, sont absurdes.

Les raisons de ces déclarations semblent être les suivantes :

• paresse ordinaire - réticence à ouvrir l'ESPD et à tout comprendre une seule fois (!);
• une soif de design, alimentée par de vénérables « écrivains techniques » individuels ;
• envie de normes bourgeoises (car il n'y a pas de prophète dans son propre pays) ;
• et beaucoup plus.

Séparément sur les normes bourgeoises. Après un certain temps, il est prévu de publier une analyse comparative du système GOST 19 et de la norme IEEE 830-1998, ainsi que de la norme IEEE 1063-2001 afin de montrer :

• supériorité générale des normes soviétiques d'il y a 25 ans ;
• « transparence » entre les bourgeois et les nôtres.

Note du 17/02/2010 - les documents spécifiés sont donnés dans l'article « ».

• GOST 19.505-79 Système unifié de documentation du programme. Manuel de l'opérateur. Exigences relatives au contenu et à la conception