Documenting a DevOps Project

Difficulty: Intermediate

Duration: 1 minute and 8 seconds

Students: 45

In Documenting a DevOps project, we start with an overview of the types of documentation that should be included in a software project and its intended audiences. We then examine the mechanisms for presenting that information within an Azure DevOps project in the form of wikis and how to set them up, exploring some of their presentation features. This is followed by demonstrations of automatically producing various types of documentation from source code and repositories within build pipelines to keep project information current.

Learning Objectives

Overview of documentation
Creating a project Wiki
Configuring release notes
Configuring API documentation
Creating a change log from Git history

Intended Audience

Azure DevOps students wanting to learn about documenting a DevOps project

Prerequisites

Familiarity with Agile and continuous delivery
Know about code repositories
Familiarity with YAML pipelines

Covered Topics