Using AI to help with documentation

Community
1

I found a good use for AI in one of my projects; my micropython font tooling, which includes a generator tool for making Unicode font packs.

Specifically; this tool is being used by non Latin1 and non-native English language speakers. Github’s traffic insight tool shows multiple matches coming from translation sites and Asian AI engines…

So; Knowing that I tend to write quite florid and ‘wordy’ documentation I decided to try and make everybody’s job easier…

I ran the whole documentation tree through ChatGPT asking it to:

Convert all free text in the following markdown document to simplified english. Preserve all formatting and technical terms.

I chose ChatGPT specifically for this; consensus is that it’s quite strong at technical language tasks and descriptions.

I’m pretty happy with the result, I only made a couple of changes to the output and totally agree with the way it has done things.

  • as a bonus it lightly linted my python examples; padding commas etc as appropriate…

The goal is to assist non english speakers in translating and using the tooling. And to reduce questions caused by complicated phrasing in my original docs.

2 Likes
2

It even fixed where you had labeled a bash invocation of python as python instead of bash code, it seems?

1 Like
3

Yes, I saw that too, lolled. There are a couple of other places where it fixed my typos too…

4

I use it all the time for coding.

I needed to create a website for work using php and js, not my strongest languages.

I just tell it what i need and it churns the code out.

Doesn’t always get it right first time.

It’s also great for adding doxygen.

2 Likes