Skip to content

AI-Gen-Documentation.md

Latest commit

 

History

History
182 lines (120 loc) · 7.27 KB

AI-Gen-Documentation.md

File metadata and controls

182 lines (120 loc) · 7.27 KB

AI Powered Software Documentation

Save Time and Effort with these AI Tools.

Disclaimer :
Prices listed as of 6 October 2025. Please check official sites for Plan & Price updates.

Github Readme Templates
Nicer Screenshots & Diagrams
Make Code Look Pretty
Convert Code Language A To Code Language B
Code Comments To Documentation
Code To PDF
Record Demo and Straight to Manual
Record Demo and Create Video Documentation
Record Auto Zoomable Video
Presentations
Create SOP With AI




Github Readme Templates

Readme Studio
WebApp | Github

  • Look in the top menu "Templates", has a nice list of templates that you can take and modify.
  • Although it says "Generate Readme", it doesn't work.
  • Go to the Github Repo, this app is open source, you need to plug-in your own API (update .env file)

Nicer Screenshots & Diagrams

Make Code Look Pretty

Convert Code Language A To Code Language B

Code To PDF

Code Comments To Documentation

Basic Assumptions

Good Code Comment Practice is Done (Video Tutorial)

Comment has to explain "WHY" the code is here, not "WHAT" this part of code doing.

🔖 Chapters:
0:00 Intro
1:01 Code documentation
3:02 #1 Comments
6:46 #2 Type hints
10:44 #3 Docstrings
13:24 #4 ChatGPT
15:20 #5 mkdocs
17:22 Final thoughts

Code Documentation Tools

According to this video, consider these options depending on your project type.

00:31 🔹 Sphinx: The Python Documentation Standard
01:02 🔹 Javadoc: For Java Developers
01:29 🔹 Doxygen: Versatile Multi-Language Support
01:59 🔹 DocFX: Modern Documentation for .NET
02:28 🔹 Swagger/OpenAPI: Documenting REST APIs Automatically

Record Demo and Straight to Manual

Scribehow

Website | Chrome Extension | Demo Video

Review Notes:

  • For Group / Team usability & onboarding, it is quite intuitive design as team members can access the recorded guides on the browser itself.

Free Plan : 10 documents
Starter Plan : USD150/month

DocsHound

Tool : https://docshound.com/
Chrome Extension : https://chromewebstore.google.com/detail/docshound/mpljambmafeklhfjlmnbheimdigkdbcg
Demo Video : https://www.yout-ube.com/watch?v=Cf0CvhQXgno

Their motto : Transform everyday explanations into living knowledge assets.

Review Notes :

  • Grant permission to your browser if you are recording your voice over.
  • It takes a few minutes to finish processing. Be patient.
  • If it doesn't refresh itself, you have to login to the dashboard and check the output
  • You can use AI to refine certain parts of your documentation.
  • The Doc is nice as it has jump links to specific sections of your video.
  • Can export document as text or markdown.
  • It functions like a mini RAG, because you can turn on a chatbot and allow people to ask question on your content. You will need to publish your content first.
    • Tip : If you have a security issue when browsing your published content, use Safari Browser and bypass the security check.
  • Give the Chatbot a test, it will show you exactly which screenshot to refer to.

Basic Plan / Free : 1 guide (which you can have multiple pages inside)
Starter Plan : USD150/month

Record Demo and Create Video Documentation

Tool : https://www.guidde.com/
Chrome Extension : https://chromewebstore.google.com/detail/guidde-magically-create-v/oacmmmjedhheaijfjidilonpngccnhdl?hl=en

Review Notes :

  • You will see a "g." icon on your screen, click on that and click on "start".
  • You don't need to record any voice over. The AI will generate it for you.
    • If you still want to record voiceover, turn on "Magic Mic", it will use your voice narration as the text in the caption.
  • Output Recordings highlight what you clicked (box and arrows)
  • Click on the "Edit" button and make adjustments.
  • You can change the language voiceover in Edit Mode (but it doesn't change the script)
    • Translation of the script is a Paid Feature.
  • You can put your profile image in your video.
  • There are brand options available in Paid Plan.
  • Share --> Export Video only available in paid option.
    • Small Trick :
      • Right-click and inspect the video, copy and paste the link in a new tab, you can still download the video.
      • Use a Chrome Extension like GoFullPage and save the document into PDF / PNG and edit out the extra stuff later in an image editor.

Free Plan : Once Sign Up, you get Free Trial 14 Days (Business Plan). After that 25 Videos a month.
Pro Plan : USD 23/month
Business Plan : USD 50/month

Record Auto Zoomable Video

Review Notes:

  • Turn on the Settings --> Experimental --> Auto zoom on clicks before recording to get the Auto Zoom feature.
  • You can make adjustments later.

Free, Open Source (Mac and Windows)

Presentations

Crunching Numbers for Your Presentation :

Tip : Use ChatGPT to build up your presentation structure / flow first before creating it with Gamma.

Create SOP With AI

Useful for managing client deliverables