La documentación de Martin del es una metodología de la documentación diseñada para proporcionar diversa información sobre procedimientos dependiendo de la audiencia y del uso del documento mientras que también preve el desarrollo del procedimiento, el cambio del procedimiento y la corrección de error en ambos procedimientos y su documentación.

La documentación de Martin se piensa para documentar procedimientos existentes y desarrollar nuevos.

OCleft

Puesta en práctica de un proyecto de la documentación de Martin

La documentación de Martin del que crea y que mantiene es un procedimiento y se puede por lo tanto sí mismo describir con la documentación de Martin del . El primer paso en la ejecución de un sistema de Martin es crear los documentos de Martin que describen los procedimientos de la documentación para la organización particular, es decir grupo de trabajo, fábrica o corporación. Sin embargo, la documentación de Martin del reconoce que diversos procedimientos requieren diversos cantidades y tipos de documentación en diversas horas, ese los procedimientos y su documentación cambia en un cierto plazo y los procedimientos se crean fuera de armazones formales. Esto significa que los procedimientos para crear los procedimientos y la documentación pueden ser muy vagos e informal al principio, e. una copia de este artículo, y entonces crece según lo necesitado con el resto del proyecto.

Marco

La documentación de Martin reconoce que los procedimientos están creados fuera de cualquier marco formal con la creatividad de la mente humana por lo tanto que un documento que describe un procedimiento puede ser una nota garabateada en un trozo de papel, documentación preexistente de antes de que el proyecto de la documentación de Martin fuera comenzado, documentación de un vendedor o cualquier otra fuente y el sistema de Martin permite que todos los documentos sean incluidos dentro de su marco.

El marco de Martin consiste en un sistema de los documentos para cada procedimiento. Los documentos para un procedimiento se pueden pensar en como estructura arborescente con un tronco, las ramas y las raíces. La misma información se repite en diversos lugares en el árbol que sugiere el almacenar de la información en una base de datos donde el software puede crear documentos según lo necesitado recolectando los detalles de la información almacenada y proporcionar enlaces hipertexto a partir de un documento a otro.

Documentos y ramas del tronco

Los documentos que componen el tronco describen formalmente el procedimiento mientras que debe ser realizado. Documentos en la tapa del tronco, los documentos más finos, describen el procedimiento en el menos detalle mientras que los documentos en la parte inferior, los documentos más gruesos, tienen la mayoría del detalle. Cada documento en un tronco contiene toda la información en el documento sobre él. El tronco se puede fijar como un esquema de extensión y almacenar electrónicamente con los diversos niveles de documentos que son creados del esquema según lo necesitado. Puede también ser deseable crear los documentos que uno podría considerar para estar en el mismo nivel sino tener detalles levemente diversos e. para el mismo procedimiento realizado con diverso equipo o en una diversa localización.

Niveles sugeridos del tronco

e., número de catálogo, número del departamento, código de proyecto, etc. (algo de esto puede ser ocultada cuando documentos más gruesos de la impresión, se consideren los documentos ancilares para el número de documento principal o toda la información de la indexación de direcciones puede ser ancilar al título.)
descripciones del título y posiblemente del texto del procedimiento del

la información de la indexación de direcciones
breves descripciones del

los pasos que se utilizarán por una persona entrenada como recordatorio y posiblemente los jefes para los pasos descritos en el documento abajo. Esto debe incluir los procedimientos para prevenir y detectar errores comunes.
descripción detallada del

cada paso en el proceso. (Este nivel o una variación de este nivel será utilizado muy probablemente como la documentación formal cuando está necesitada.)
descripción detallada del

cada paso con las notas y las explicaciones sobre situaciones particulares y de acoplamientos a los procedimientos para corregir errores.
el

arriba con explicaciones sobre porqué ciertos pasos se hacen una manera particular de ser utilizado como guía al convertirse cambia a los procedimientos o a crear un procedimiento en marcha para corregir un error.

Ramas

Cada documento en el tronco se puede asociar a los documentos ancilares que se pueden representar en una base de datos como acoplamientos a la otra información incluyendo otros documentos del procedimiento.

Documentos de la raíz

Los documentos de la raíz pueden ser bonitos mucho cualquier cosa que tiene que hacer con el procedimiento. Contendrá a menudo documentos históricos, fuentes exteriores y documentos sobre situaciones infrecuentes. Todos los procedimientos comienzan mientras que los documentos de la raíz incluso si existen solamente en la mente. La mayoría de los procedimientos se convertirán en parte del sistema de Martin por la inclusión como documento de la raíz. Esto permite que un procedimiento sea incluido simplemente dándole un título y acoplamientos a otros documentos en el sistema. Las bases de datos de computadora permiten que los documentos de la raíz sean almacenados electrónicamente o pueden proporcionar la información para encontrar documentos físicos.

Principios de documentación de Martin

Inclusión

Los procedimientos y los cambios a los procedimientos originan fuera del sistema y se deben poner en el sistema de Martin del antes de que se pierdan. La gente debe ser animada a registrar cualquier idea sobre un procedimiento en cualquier forma para por lo menos poderla incluir como documento de la raíz y disponible para el desarrollo futuro. Todos los procedimientos comienzan como un título o número del procedimiento atado a un documento de la raíz. Algunos documentos de la raíz se pueden también enlazar como documentos ancilares a los documentos del tronco. Los procedimientos para incluir documentos de la raíz no deben ser así que el complejo en cuanto a desalienta su inclusión y se debe en lugar de otro diseñar animar su inclusión.

Para muchos procedimientos el documento de la raíz puede ser todo que se requiere por un tiempo muy largo y un esfuerzo para crear documentos más gruesos del tronco no se debe considerar una necesidad.

Extensión

Si es necesario crear o cambiar un documento del tronco, los documentos de la raíz, los documentos existentes del tronco y los documentos ancilares existentes están disponibles como recurso. Puede ser que sea provechoso crear un documento del procedimiento que describía cómo tomar la decisión para ampliar la documentación de un procedimiento. En qué nivel se crea un documento del tronco debe depender de la naturaleza de la necesidad y de la documentación existente del procedimiento particular.

Prevención, corrección y detección de error

Los procedimientos deben incluir la prevención, la detección y la corrección de errores. Los procedimientos para corregir errores no deben animar a gente a dejar errores sin corregir.

Historia

La documentación de Martin fue inspirada por la evolución natural de la documentación de software en proyectos del software libre . Descrito original por Jeffrey Juan Martin.