How to Create a Software User Manual with AI

How to Create a Math Quiz with AI for Free (No LaTeX Knowledge Needed!)

When implementing new software in your company, you often create user manuals on how to use it. Have you felt tedious manually taking screenshots for the steps and adding them to your manuals? In this article, you will lighten this heavy burden by delegating most of this work to AI. Before proceeding, you will need a Google account, and I assume you already created a folder to store a video on your computer.

Step-by-Step Guide

Preparation 1: Install FFmpeg on Your Computer

First, you need to install FFmpeg. Choose your operating system (OS) to get started.

Step 1: Record Steps in Your Manual in a Video

After you installed FFmpeg, record the steps you want to explain in the manual in a video.

  1. Record the video using the default screen recording tool on your computer. Choose your OS, and follow the steps.

  2. Move the video file to the folder you want to store the video in. If you don't know how to do this, here're ways for your OSs.

Step 2: Opt Out Your Chats from Machine Learning

Since your video contains sensitive information, opt out your chats from the machine learning of Gemini AI.

  1. Visit https://gemini.google.com.
  2. In the sidebar, click "Settings & help."
    Source: https://gemini.google.com
  3. Click "Activity."
    Source: https://gemini.google.com
  4. Click "On."
    Source: https://myactivity.google.com
  5. Click "Turn off."
  6. Read the text if you want, and click "Got it."
    Source: https://myactivity.google.com
  7. Click "Got it."
    Source: https://myactivity.google.com
  8. Your chats are opted out.
    Source: https://myactivity.google.com

Step 3: Extract Frames from the Video

After you record the video, extract frames for the steps using FFmpeg.

  1. Visit https://gemini.google.com.
  2. Enter this prompt template in the textbox in the center of the page.
    [Task]: Generate FFmpeg commands that extract key frames from this video, which match before and after each process in the list below. 
    [Operating System]: (Specify your OS)
    [List]:
    (Describe the steps in numbered lists)
    [Constraints]:
    - Output must only be a copyable code snippet.
    - The frames' file type must be PNG format.
    - Concatenate all commands with `;` if [Operating System] is "Windows" or "Linux" or `&&` if [Operating System] is "Mac."
    
    ```text
    (an FFmpeg command here) ; (another FFmpeg command here)
    ```
    
    - When specifying a video file in an FFmpeg command, specify it in every command.
  3. Complete the bold placeholders enclosed with "(" and ")."
  4. Click "+" beside the button "Tools."
  5. Click "Upload files."
  6. Upload the video.
  7. Click "2.5 Flash."
    Source: https://gemini.google.com
  8. Choose "2.5 Pro."
  9. Click Enter.
  10. FFmpeg commands will be generated.
  11. Click the copy button with 2 layered squares.
    Source: https://gemini.google.com
  12. Go back to the PowerShell screen if Windows, the Xcode Command Line Tools screen if Mac, and the Bash screen if Linux.
  13. Enter this command. For path, replace it with the path of the folder where you stored the video.
    cd (path)
  14. Press Enter.
  15. Paste the copied command in the console (text-enterable area).
  16. Click Enter.
  17. Frames will be extracted from the video.

Step 2: Generate a Manual

  1. Visit https://gemini.google.com.
  2. Click "+."
  3. Click "Upload files."
  4. Upload the first 10 extracted frames.
  5. Click "Tools."
  6. Click "Canvas."
  7. Enter this prompt template in the textbox.
    [Task]: Create a step-by-step HTML user manual.
    [Purpose]: (Explain the purpose)
    [Process To Explain]:
    (Copy and paste the same numbered lists as you wrote in the last prompt)
    [Target]: (Specify the target audience)
    [Constraints]:
    
    - Use clear yet simple language.
    - Avoid jargon unless necessary.
    - Use provided images to clearly illustrate processes.
    - When adding the uploaded images in the manual, every image file path must be only the file name plus `.png`, even when the file formats of these images are JPG.
    - If one numbered list contains more than one step, break them into single processes.
    - Use consistent, user-friendly design.
  8. Complete the bold placeholders enclosed with "(" and ")."
  9. Press Enter.
  10. A Manual will be generated. Please note that the frames may not be displayed correctly to match the file paths in the manual to the frames' paths, but it's not a problem.
    Source: https://gemini.google.com
  11. In the same textbox, enter this prompt.
    Here are the rest of images I forgot to upload. Using these images as well as the existing ones, recreate the manual.
  12. Click "+"
  13. Click "Upload files."
  14. Upload the rest of the frames.
  15. Press Enter.
  16. Repeat the 11th to 15th steps until you can upload all frames in the chat.
  17. Click "Code" beside the "Preview" button.
    Source: https://gemini.google.com
  18. Select the entire code by pressing Ctrl + A if using Windows or Linux-first personal computers, or + A if using Mac.
    Source: https://gemini.google.com
  19. Visit this HTML code downloader.

    ⚠️Please note that this app is created by me, and I don't collect any personal information from you.

  20. Paste the copied code in the textbox.
  21. Click "Download HTML File."
  22. The HTML file will be downloaded.

Step 4: Check and Edit the Manual

Once your manual is created, check if there are missing steps and if the used screenshots are consistent with the texts. If needed, ask Gemini for correcting them.

Here's the example of a manual.


Benefits of Using AI-Generated Manuals

It's Fast.

Creating a manual with screenshots often takes hours. But if you bring in this heavy lifting to Gemini, you can make your idea a manual faster than full manual creation by humans, and you will only need to check and edit the manual. Thus, you can focus on more valuable tasks like the development of busineess improvment apps.

It's User-friendly.

First of all, your manual is targeting your audience, not you. One redditor complained that the user had a difficult time understanding technical language. But sometimes, the terminologies are useful because they are easier than explaining with long text. But don't worry. Gemini can rephrase your words in simpler terms. On top of that, it can break what you think is one process down into single, actionable steps. As a result, you will be able to reduce queries because of confusion about your manual.

It's Updated Faster.

Another redditor failed Proof of Concept, which verifies the feasibility of new ideas and concepts. One reason is that the documentation of the software "Foreman" didn't seem to keep up with the releases, leaving old screenshots. I felt that this product team could have updated their documentation with this AI hack then. By the addition of new screenshots, they could also have simplified their software. So that it won't happen these in your company, Gemini also helps you streamline your manual generation task.


Troubleshooting

Screenshots aren't displayed correctly.

If your screenshots aren't displayed correctly, ask Gemini with this prompt.

It seems some images aren't displayed correctly. Make sure the file names are the same as the uploaded images, and the file formats are `.png`.

In summary, this article tackled the problem with traditional manual creation by delegating this work to 2 Gemini AI models: Gemini 2.5 Flash and 2.5 Pro. If this information is helpful, I'm glad if you share your thoughts on social media. You can share this article by click the button with 3 connected dots below.

Comments