Documentation de Martin

La documentation de Martin de est une méthodologie de documentation conçue pour fournir des informations différentes au sujet des procédures selon l'assistance et l'utilisation du document tout en également prévoyant le développement de procédé, le changement de procédé et de correction d'erreurs des deux procédures et leur documentation.

La documentation de Martin est prévue pour documenter des procédures existantes et développer des neufs.

OCleft

Exécution d'un projet de documentation de Martin

La documentation de création et de maintien de Martin de est un procédé et peut donc lui-même être décrite avec la documentation de Martin de . La première étape en mettant en application un système de Martin est de créer des documents de Martin décrivant les procédures de documentation pour l'organisation particulière, c. équipe de travail, usine ou société. Cependant, la documentation de Martin de identifie que les différentes procédures exigent différents quantités et types de documentation à différentes heures, ce des procédures et leur documentation changent avec le temps et des procédures sont créées en dehors de des cadres formels. Ceci signifie que les procédures pour créer les procédures et la documentation peuvent être très vagues et sans cérémonie au début, par exemple une copie de cet article, et se développent alors comme nécessaire avec le reste du projet.

Cadre

La documentation de Martin identifie que des procédures sont créées en dehors de n'importe quel cadre formel par la créativité de l'esprit humain donc qu'un document décrivant un procédé peut être une note griffonnée sur un morceau de papier, documentation préexistante de avant que le projet de documentation de Martin ait été lancé, documentation d'un fournisseur ou n'importe quelle autre source et le système de Martin permet à tous les documents d'être incluse dans son cadre.

Le cadre de Martin se compose d'un ensemble de documents pour chaque procédé. Les documents pour un procédé peuvent être considérés comme une structure arborescente avec un tronc, des branches et des racines. La même information est répétée dans différents endroits dans l'arbre qui suggère de stocker l'information dans une base de données où le logiciel peut créer des documents comme nécessaires en recueillant des détails de l'information stockée et fournir des liens hypertextes d'un document à l'autre.

Documents et branches de tronc

Les documents composant le tronc décrivent formellement le procédé pendant qu'il devrait être exécuté. Documents au dessus du tronc, les documents plus minces, décrivent le procédé dans le moindre détail tandis que les documents au fond, les documents plus épais, ont la plupart de détail. Chaque document dans un tronc contient toute l'information dans le document au-dessus de lui. Le tronc peut être installé comme un contour en expansion et être stocké électroniquement avec les différents niveaux des documents étant créés du contour comme nécessaire. Il peut également être souhaitable de créer les documents qu'on pourrait considérer au même niveau mais d'avoir les détails légèrement différents par exemple pour le même procédé exécuté avec l'équipement différent ou à un endroit différent.

Niveaux suggérés de tronc

numéro de document de l'information d'indexation de

par exemple, numéro de catalogue, nombre de département, code du projet, etc. (une partie de ceci peut être cachée quand des documents plus épais d'impression, soient considérés les documents auxiliaires pour le numéro de document principal ou toute les information d'indexation peut être auxiliaire au titre.)
descriptions de titre et probablement de textes de procédé de

d'information d'indexation
descriptions courtes de

s étapes à employer par une personne qualifiée comme rappel et probablement des en-têtes pour les étapes exposées dans le document dans ce qui suit. Ceci devrait inclure des procédures pour empêcher et détecter des erreurs communes.
description détaillée de

chaque étape dans le processus. (Ce niveau ou une variation de ce niveau sera très probablement employé comme documentation formelle une fois nécessaire.)
description détaillée de

chaque étape avec des notes et des explications au sujet des situations particulières et de liens aux procédures pour corriger des erreurs.
le

ci-dessus avec des explications au sujet de pourquoi certaines étapes sont faites une manière particulière d'être employé comme guide en se développant change en procédures ou créer un procédé en marche pour corriger une erreur.

Branches

Chaque document sur le tronc peut être associé aux documents auxiliaires qui peuvent être représentés dans une base de données comme liens à l'autre information comprenant d'autres documents de procédé.

Documents de racine

Les documents de racine peuvent être jolis beaucoup de quelque chose qui doit faire avec le procédé. Souvent il contiendra les documents historiques, les sources extérieures et les documents au sujet des situations peu fréquentes. Toutes les procédures commencent pendant que des documents de racine même si elles existent seulement dans l'esprit. La plupart des procédures deviendront une partie du système de Martin par l'inclusion comme document de racine. Ceci permet à un procédé d'être inclus en lui donnant simplement un titre et des liens à d'autres documents dans le système. Des bases de données d'ordinateur permettent à des documents de racine d'être stockés électroniquement ou peuvent fournir des informations pour trouver les documents physiques.

Principes de documentation de Martin

Inclusion

Les procédures et les changements aux procédures proviennent de en dehors du système et doivent être mis dans le système de Martin de avant qu'elles soient perdues. Les gens devraient être encouragés à enregistrer toutes les idées au sujet d'un procédé sous n'importe quelle forme de sorte que pour le moins elle puisse être incluse comme document de racine et disponible pour le futur développement. Toutes les procédures commencent comme titre ou nombre de procédé attaché à un document de racine. Quelques documents de racine peuvent également être liés en tant que documents auxiliaires aux documents de tronc. Les procédures pour inclure des documents de racine ne devraient pas être ainsi le complexe quant à découragent leur inclusion et devraient à la place être conçus pour encourager leur inclusion.

Pour beaucoup de procédures le document de racine peut être tout ce qui est exigé pendant un temps très long et un effort de créer des documents plus épais de tronc ne devrait pas être considéré une nécessité.

Expansion

S'il est nécessaire de créer ou changer un document de tronc, les documents de racine, les documents existants de tronc et les documents auxiliaires existants sont disponibles comme ressource. Il pourrait être utile de créer un document de procédé décrivant comment prendre la décision pour augmenter la documentation d'un procédé. Quel niveau un document de tronc est créé devrait dépendre de la nature du besoin et de la documentation existante du procédé particulier.

Empêchement, correction et détection des erreurs

Les procédures devraient inclure la prévention, la détection et la correction des erreurs. Les procédures pour corriger des erreurs ne devraient pas encourager des personnes à laisser des erreurs non corrigées.

Histoire

La documentation de Martin a été inspirée par l'évolution naturelle de la documentation de logiciel dans des projets du logiciel gratuit . À l'origine décrit par Jeffrey John Martin.

Random links: