1What the KIT produces

This document is a translation in substance. The reference is the original document in French; extensions and changes are always made there.

You describe your subject to an artificial intelligence. It applies presentation rules already written and produces three formats: Word files, PDF, and the pages of a website.

The content is entered once; the three formats follow from it. The artificial intelligence assistant — Claude, Gemini, Grok or another — is the one you choose: the KIT sets the rules and the production chain, it depends on no vendor. It also hides the technical side, and you concentrate on your documentation.

Three questions are settled before the first line: they determine how the content is organised, and taking them up again later forces a rewrite.

2Who are you writing for

The audience determines the vocabulary, the level of detail and what may be assumed known.

–People in the field. Your vocabulary can be used as it stands. The document is dense and short.

–People new to it. Terms are defined, the example comes before the rule. The document is longer and works step by step.

–Yourself, two years from now. You write what you will have forgotten: the reason for a choice, what had been tried before.

A document written for two of these audiences is too detailed for one and too elliptical for the other. One audience per document.

3In what form

Two forms of reading. The paper binder sets an order, a page numbering and a cover page; it reads without equipment. The site updates in a single operation, can be searched by keyword and shared through a link.

Both are produced from the same source.

4In what language

One or several. The KIT produces the variants and publishes them side by side, with a language selector on the site.

Planned from the start, this point is one line of configuration. Added later, it forces every document to be taken up again and the authoritative version to be designated.

5Two tricks that will make your documentation easier to manage

–A file name that speaks. The rule itself matters little; what counts is recognising a file without opening it. The KIT adds the date and time to every name, which makes version management easier.

–One document is authoritative. Two files will end up contradicting each other — that is normal in a project that evolves. Once the gap is spotted, tell the assistant which of the two is the source; the others fall in line.

6What you publish

Part of your documentation stays internal: working notes, task lists, items not yet settled. The status is decided document by document, at the moment it is created.

A document that is not published stays in the binder and does not appear on the site. A publication is hard to take back: content put online may have been read, copied or indexed before its removal.

💡If part of it should stay accessible to a limited group, most hosting services allow a directory to be protected by a password, without changing the pages themselves.

7Working with artificial intelligence

It writes the formatting, produces the files and keeps the conventions. You bring the content.

No assistant is perfect today: there will be clumsy turns of phrase, and mistakes. Always reread what it produces with the eyes of the audience you have in mind, and teach it to adapt.

Note:The KIT runs its own checking tools before each delivery. They catch what can be verified mechanically — structure, sequences, version. A phrase that rings false or a poorly chosen example show only on reading.

8Going further

The KIT's presentation may not suit you — no problem. You can adapt the formatting and add your own layouts alongside, without modifying the original. You can then go on receiving updates without overwriting your extensions. The procedure is described in Extending the Kit.

9If you want to get started…

The KIT downloads as a ZIP file from the site kit.sliver.lu — the icon at the top right of the home page.

The initialisation guide describes what follows.