Practical guide · IT documentation
Prepare IT documentation with AI and human review
Work notes often contain knowledge that could help with a later task. AI can organise approved information into a documentation draft. Whether it becomes a useful operating procedure depends on the sources, professional review and intended use. A draft is not a confirmed procedure. Publishing and accepting it require a responsible person who assesses its content and validity.
Discuss a documentation pilotChoose a limited documentation task
A useful starting point is a clearly defined task: an internal checklist for a known support workflow, for example, or a structured description of approved work steps. Define who the text is for and which prior knowledge it assumes. Instructions for an experienced administrator need different information from guidance for the service desk.
AI should structure existing knowledge. It cannot turn missing prerequisites into a reliable procedure. If sources conflict or describe different system versions, a knowledgeable person must clarify that uncertainty before the draft is accepted.
Prepare sources and prerequisites
Suitable inputs include approved procedures, redacted work notes and known verification rules. Record which system and version the information concerns. The required role, permitted actions and conditions for stopping or escalating the process also matter.
Redact unnecessary confidential content without breaking the factual context. A system placeholder needs to stay consistent. Passwords, tokens and private customer details do not belong in a documentation draft. The AI provider used and processing of the intended input fields must be approved before implementation.
The structure a draft needs
The output should make later review easier. Separate prerequisites, individual steps and success checks. An observation is not a command, and a suggested step is not a confirmed action. Where information is missing, the draft should show an open question. A source or traceable reference helps connect statements to their basis.
- The purpose, audience and scope of the procedure
- Required information, roles and technical prerequisites
- Steps derived from sources in a traceable sequence
- Checks, stop conditions and open questions
- Source version and named responsibility for professional review
Synthetic example: a checklist with a visible gap
Suppose an invented support note describes a VPN interruption. The local network connection has been checked; reviewing an approved service status is the next planned step. However, the note does not identify where that status can be found. This example is synthetic and is not a customer case.
Expected draft: “Next step: check service status. Open: the approved status source and required role.” Inventing commands or restarts cannot fill that gap. The reviewer clarifies source, role and scope. Until then, the step is not approved for use.
Professional review before publishing and use
Check every statement against the approved sources: are prerequisites complete? Do the role and system version match? Is each step supported by evidence, and is its verification described? Where practical tests are needed, they take place in the appropriate test environment with agreed permissions. The AI output itself does not execute the actions it describes.
A readable text can be outdated or factually wrong. Draft status, source version and open questions therefore stay visible. Agreed acceptance follows human review. Who is responsible for later changes and when another review is needed are part of defining the documentation workflow.
Limit the workflow within a pilot
The AI Automation Pilot can implement a documentation workflow in an agreed test environment. Input, output format and the human review step are scoped. Normal cases and missing or conflicting sources are evaluated using suitable redacted examples. A test report and handover instructions describe the evaluated scope and known limitations.
Production publication, further integrations and ongoing maintenance are agreed separately. For the initial assessment, describe the desired documentation task, available sources and who would review the content. Do not send credentials or confidential notes to start. Daniel Djogic discusses the prerequisites directly with you.
Frequently asked questions
Can AI complete a procedure from a few notes?
It can organise approved information and identify gaps. Unsupported prerequisites, commands and solutions must not be added as established knowledge. A responsible person needs to provide missing professional information.
Who approves the draft?
A person named by your team checks factual accuracy and the intended scope of use. The role and acceptance step are defined within the workflow. Automatically generating a text does not make it approved.
Will the documentation stay up to date automatically?
A later change to the sources requires a defined approach to versions and renewed review. The test pilot does not promise ongoing updates. Further integrations and continuous maintenance are agreed separately.
Can a draft go directly into the knowledge base?
The pilot provides a draft within the agreed test workflow. Production publication and the appropriate integration require a separate agreement. The human review step must be clear before the content is used professionally.
Your direct point of contact: Daniel Djogic
SUPPE LABS is Daniel Djogic’s sole proprietorship. You discuss your starting point, scope and result directly with the founder. Together, you clarify prerequisites, define the assignment and review the results.
Meet Daniel and explore his approachClarify the next step together
Describe your workflow, the tools involved and who would review the result. After your enquiry, we assess whether the prerequisites fit. An assignment begins only through a separate offer.
Discuss a documentation pilot