1, 2, 3, Doc Kit!

Automate the creation of software documentation

12:0015 mins08/11/2024

Doc Kit is an open source command line tool that automates the creation of software documentation and release notes.
It can be used in conjunction with DocBook Authoring and Publishing Suite (DAPS) for quickly preparing the skeleton of professional looking software documentation.

Doc Kit has been designed for initialising SUSE or openSUSE documentation repositories but in a few steps it can be re-used for other projects too.
The tool consists of two parts:
1. a command-line tool called doc-kit that can download documentation boilerplate files
2. a repository of documentation boilerplate files, such as the SUSE/openSUSE book preface and entity files.

The presentation will show how to use Doc Kit and how to customise the provided templates for creating a brand new documentation or release notes projects.