Services for Documentation

Its fair to say that most software is now online first and today more companies are offering an API to interface with or an App to install. The need for good documentation is vital for companies of all sizes.

Writing documentation can be a very time consuming task, but it does not stop there it then needs to be published.

Once the documentation is published you will need to be able to make updates to keep it up to date. The speed and ease of performing the updates is important for a number of reasons, as keeping up to date in a timely manor could bring your business success and growth.

Getting the Doc's online

Whilst its true in software that there is always more than one way of doing things, starting from a version controlled basis is always a great idea. You then have to think about how you are going to write and store your documentation. Maybe you are happy writing them in markdown which is a great choice. Which then brings the question of are you going to use an editor or do you require a custom form

Once all the above questions are explored you can start to think about how the publishing of the website from the repository is going to be set up and configured.

Once all the above questions are explored you can start to think about how the publishing of the website from the repository is going to be set up and configured.

A large number of packages are available to build documentation systems which commonly take the markdown in merge it with a template and template language to build a deployable website into an output folder. You could use a GitHub Action to take this output folder and deploy it to your hosting. The build and deploy steps can be automated into a publishing pipeline to start once the repository branch is updated.

As well as offering a documentation website you might want to offer an option for the pages to be saved as a pdf. Which can be automated for the server to build from the published webpage.