Cómo crear rápidamente documentación para una base de datos de SQL Server

En esta publicación de blog, aprenderemos cómo crear rápidamente la documentación completa de la base de datos de SQL Server utilizando la herramienta de documentación SQL de Devart.

Hay muchos beneficios que obtiene al generar automáticamente la documentación de la base de datos utilizando dbForge Documenter para SQL Server. No necesita pasar horas buscando y escribiendo información técnica desde cero. La herramienta de documentación de la base de datos crea documentación precisa y sin errores en solo unos minutos. Además, Documenter proporciona un amplio conjunto de funciones para personalizar la salida de la documentación para que se ajuste a sus requisitos específicos.

Documenter proporciona documentación en un formato fácil de ver para que pueda compartirla con su supervisor o clientes, otros desarrolladores, administradores de bases de datos, evaluadores, gerentes de proyectos, líderes comerciales u otros seres queridos.

El siguiente ejemplo muestra cómo crear documentación para AdventureWorks2012 base de datos de muestra.

1. Ejecute dbForge Documenter para SQL Server. Hacer clic Nuevo documental… sobre página de inicio.

página de inicio del documentalista

2. En el arte Seleccionar conexiones cuadro de diálogo, seleccione una o más conexiones existentes de la lista o cree una nueva. Hacer clic Escoger.

Seleccione una conexión

3. Se abre el proyecto Documentador de base de datos.

Cubrir

4. en Avance el panel muestra inicialmente Cubrir documentación en la que se pueden incluir enlaces a migas de navegación, añadir un logotipo, especificar el título, título y texto descriptivo de la documentación, indicar el autor y fecha de creación.

En la esquina superior derecha Estilo lista desplegable, puede elegir un estilo que defina la apariencia del contenido de la documentación. Documenter contiene una serie de plantillas de estilo y también le permite usar diferentes temas de Bootstrap para cambiar el diseño y la apariencia de la documentación.

Estilo de documentación

5. En el cuadro de búsqueda Estructura panel, comience ingresando el nombre de la base de datos que desea documentar. Por ejemplo, ingrese "Publicidad…“. A medida que escribe, Documenter filtra las bases de datos y muestra solo las que coinciden, y selecciona las letras apropiadas del texto de búsqueda.

6. En el arte Estructura haga clic en la flecha junto a AdventureWorks2012 para expandir la lista de objetos de la base de datos. Documenter comienza a recuperar datos de la base de datos y analiza su estructura. Documenter recupera información extensa sobre la base de datos, incluida una amplia gama de tipos de objetos SQL, sus detalles, propiedades y relaciones entre objetos y códigos DDL.

Recuperar metadatos de una base de datos

7. Una vez extraídos los datos, Estructura el panel muestra la estructura de la vista en forma de árbol de los componentes disponibles en la base de datos. Puede ampliar aún más los componentes haciendo clic en las flechas.

8. Seleccione las casillas de verificación junto a los componentes que desea incluir en la documentación. Estos pueden ser componentes de diferentes niveles, como una base de datos completa, una tabla específica o una columna de tabla.

Estructura de la documentación

9. El panel derecho muestra una vista previa de la información que se incluirá en la documentación. La información se presenta en las siguientes secciones: Descripción, tipos de objetos, Propiedades, Opciones, Archivos de base de datos, y Secciones para incluir. Estas son secciones a nivel de base de datos. Sin embargo, Documenter le permite personalizar elementos de documentación en varios niveles, que incluyen:

- nivel de servidor;
- nivel de servidor;
- nivel de las bases de datos;
- nivel de base de datos;
- el nivel del grupo de objetos;
- nivel de objeto de la base de datos.

por ejemplo, en Estructura haga clic en la flecha al lado Mesas para expandir la lista de tablas en AdventureWorks2012 base de datos y luego seleccione Persona Dirección tabla de la lista.

Documenter muestra una vista previa de una tabla con secciones individuales (Descripción, Propiedades, columnas, Índices, Llaves extranjeras, secuencia de comandos SQL, Depende de, Usado) a incluir en la documentación. Puede excluir cualquiera de las secciones enumeradas, así como ciertas propiedades (en Propiedades sección) para Persona Dirección tablas para que no aparezcan en la documentación creada.

Vista previa de la estructura de la tabla

De la misma manera, puede personalizar la documentación excluyendo secciones y propiedades de objetos de diferentes niveles mencionados anteriormente, como servidores, bases de datos, vistas, procedimientos almacenados, etc.

10. El texto de descripción que se inserta automáticamente en Descripción el campo para cada objeto de la base de datos se extrae del archivo MS_Descripción propiedades avanzadas. Puede editar las descripciones directamente en el Documenter.

Propiedades avanzadas de MS_Description

11. Cuando termine, presione Crear pasar a la creación de documentación.

Crear botón

12. C Creación de documentación se abrirá un cuadro de diálogo y se le pedirá que seleccione un formato de archivo para la documentación. HTML es adecuado, por ejemplo, para publicar bases de datos en Internet y PDF, para distribuir a varios sistemas y dispositivos. Ambos formatos se pueden buscar, lo cual es muy conveniente, especialmente para grandes bases de datos.

13. Especifique la carpeta para guardar la documentación generada. Opcionalmente, puede optar por Agregar una marca de tiempo al nombre del archivo y para Documentación abierta después de la generación.

Formato de la documentación

14. Haga clic en Crear para empezar a generar AdventureWorks2012 documentación. Documenter muestra el progreso de la generación.

Creación de documentación

15. Después de una generación exitosa, Documenter abrirá la documentación generada si Documentación abierta después de la generación se seleccionó la opción. De lo contrario, abra la carpeta de destino que especificó para examinar la documentación.

Características adicionales

Una de las excelentes características de Documenter es que se integra fácilmente con SQL Server Management Studio (SSMS). Las bases de datos se pueden documentar directamente desde el Explorador de objetos de su solución SSMS.

Además, Documenter es parte de dbForge Developer Bundle para SQL Server, el mejor conjunto de herramientas de Devart, que combina características que le permiten monitorear versiones de bases de datos, comparar esquemas y datos, optimizar el rendimiento de la base de datos y escribir consultas SQL sobre la marcha. genere datos de prueba significativos y más directamente en su IDE favorito.

Conclusión

Como puede ver, dbForge Documenter for SQL Server automatiza por completo el proceso de creación de documentación y reduce la cantidad de esfuerzo requerido manualmente, brindando una descripción técnica hermosa y completa de la base de datos de SQL Server.

Artículos de interés

Subir