Better Documentation: All Images

Types of Software Documentation

Figure 1

Undraw.co image of a developer Undraw.co image of a user

Documentation Better Practices

Figure 1

Getty Images - a image displaying a cartoon rendition of a peanut butter and jelly sandwich

Make a gh-pages branch. Either from the GUI or through command line, make a new branch named gh-pages. In the GUI, you would do this by clicking on the branches link: On the main repository page, the branches link is circled (directly to the right of the `main` branch dropdown)

On the main repository page, the branches link is circled (directly to the right of the `main` branch dropdown)

Then click on “New branch”: On the branches page, the "New branch" button on the top-right is circled

Name it gh-pages: Create a new branch pop-up dialog with the name `gh-pages` typed into "New branch name" text box

Figure 3

Set up GitHub to build from that branch. In the GUI, go to “Settings” > “Pages”: Under the Settings tab, the Pages section is selected. Shows option for "Build and deployment" that include Source, branch, and Custom domain

Under the Settings tab, the Pages section is selected. Shows option for "Build and deployment" that include Source, branch, and Custom domain

Change the settings to “Source: Deploy from branch”, “Branch: gh-pages”, and “directory /docs”. Then hit “Save.” GitHub Pages modified settings - Source is set to "Deploy from a branch", Branch is set to `gh-pages`, and directory is set to `/docs`

GitHub Pages modified settings - Source is set to "Deploy from a branch", Branch is set to `gh-pages`, and directory is set to `/docs`

Introduction

Figure 1

Types of Software Documentation

Figure 1

Documentation Better Practices

Figure 1

Documentation in Practice

Documentation Tools

Figure 1

Figure 2

Figure 3