DAUX.IO: Per generator to own documentation for software, APIs, or … – t3n Magazine

develop

Software to create interfaces or realize their own products – there is a lot of work and sweat. But what brings a work when no one can use the product at the end – because not the required expertise is available? So a documentation must be found which clearly and simply can convey all the important features and options to the user. Not an easy task, but perhaps we have with DAUX.IO already found our solution.

In the worst case, a documentation is confusing and difficult to understand. It will take a long time for the interpretation, which can quickly jump from train our new development user. To prevent this problem, we should documentation not shift our mental priorities in the last drawer.

If we use the right software to create our documentation, we have not only our users a favor, even we can benefit from pre-defined structures, functions and templates. This brings us a large labor savings and less frustration

DAUX.IO:. The generator for your documentation

Towards the perfect documentation: DAUX and the inline editor. (Screenshot: DAUX.IO)

DAUX.IO describes himself as a generator and is not just a template or boilerplate, but a complete toolkit with which we can create our documentation. First we have to invite the official DAUX.IO GitHub repository and install them on our server. What is needed is just a PHP 5.3 + support. Those who prefer to run locally DAUX.IO can do so directly through Grunt. Once we call now the directory on our server or locally, we get an image of the DAUX.IO page.

Below, we can customize the demo files that we find in the docs folder. We can edit and store the Markdown files directly. The advantage that we are not directly in the source code need to move HTML elements is, obvious. Even novice can create the content of the documentary about the simple Markdown syntax. The folders under the docs directory automatically organize the navigation, and it can easily and quickly a simple structure can be created.

About the related config.json file that is located in the doc directory, can more adjustments are made, for example, when it comes to Google Analytics connection, the template or the File Editor, which allows for direct editing. In addition, there are the themes, the GT in the folder templates &; default hide. Here we can create our own theme or editing an existing

The documentation with DAUX.IO:. The advantages at a glance

With DAUX.IO we have a documentation generator, with the few clicks can be installed. It has its own theme engine that allows to customize the design. About the Markdown syntax even non-developers to fill the documentation with life. The definition of menu and structure will be implemented quickly and easily through the directory hierarchy. Routing is SEO-friendly and the entire application responsive.

If you’re still unsure about her, whether DAUX.IO is the right solution, you can look at you yet more demos. Who can not do anything with DAUX.IO, perhaps with the paid alternative ReadMe.io better served.

Have you had any experience with DAUX.IO made or do you use a completely different documentation software?