Documentation

SQLServerCentral Editorial

Creating Documentation

  • Editorial

Who should create documentation for software? In many companies, it's the developers. In fact, in Redgate, often our developers are tasked with updating articles for products on our documentation site. We do have a streamlined process that has developers can submitting changes in some format (markdown? ) and an automation process that automatically updates the […]

You rated this post out of 5. Change rating

2023-04-26

206 reads

SQLServerCentral Article

Reading and Writing your Database's Documentation using JSON

  • Article

One of the problems to which I keep returning is finding the best way to read and apply documentation for databases. As part of a series of articles I'm doing for Redgate's Product Learning, I've been demonstrating how to maintain a single source of database documentation, in JSON, and then add and update the object […]

You rated this post out of 5. Change rating

2021-06-28 (first published: )

3,564 reads

External Article

Documenting your SQL Server Database

  • Article

One of the shocks that a developer can get when starting to program in T-SQL is that there is no simple way of generating documentation for routines, structures and interfaces, in the way that Javadocs or Doxygen provides. To embed the documentation in the source is so obvious and easy that it is a wrench to be without this facility. Phil Factor suggests a solution.

2015-05-18

9,083 reads

SQLServerCentral Article

Oiling the gears for the data dictionary

  • Article

Documenting the database is always a challenge, and there are many techniques you can use to help all the people on your team understand what all your tables are used for. David Poole brings us an easy way to implement a framework for documentation.

4.75 (51)

You rated this post out of 5. Change rating

2014-04-25 (first published: )

14,594 reads

Blogs

How to: Regain SysAdmin Access to a SQL Server Instance Without the SA Password

By

Hello, reader! Today, I’m going to walk you through a scenario that many DBAs...

Secure Your SQL Estate: Best Practices for Azure SQL Security

By

The Castle and the Keys Imagine your Azure SQL environment as a sprawling digital...

The Book of Redgate: Meetings

By

I think we might have forgotten this a bit, but on one of the...

Read the latest Blogs

Forums

Visual Studio SSIS Package Showing Up Blank

By DAhmed

Hi all, this is my first time posting on this forum, thank you all...

MySQL 5.6 not writing any logs

By Forum Researcher

We are using MySQL version 5.6 in our Windows Server 2012 R2 environment. We...

How to resolve issue of custom Audit log table containing incorrect data?

By Kevin8

We have created a parent table, child table & Audit log table in SQL...

Visit the forum

Question of the Day

Change Tracking Default Retention

I run this command on my SQL Server 2022 database:

ALTER DATABASE AdventureWorks2017 SET CHANGE_TRACKING = ON;
What is the default data retention period?

See possible answers