II - HTML Sanity Checking

The system that's documented in this lesson is a small open source tool that's hosted on GitHub (https://github.com/aim42/htmlSanityCheck).

The full source code is available from the preceding link – you may even want to configure your Gradle build to use this software. If you're writing documentation based on Asciidoctor, this would be a great idea!

But enough preamble. Let's get started.

II.1 Introduction and Goals

This section will explain the driving forces for architecturally relevant decisions and important use cases or features, all of which will be summarized in a few sentences. If possible, refer to the existing requirements documentation.

The main goal of this section is to ensure that your stakeholders understand the solution at hand.

HtmlSanityCheck (HtmlSC) supports authors creating digital formats by checking hyperlinks, images, and similar resources.

1.1 Requirements Overview

Note

If you would...