cancel
Showing results for 
Search instead for 
Did you mean: 

What's the value of efforts towards better documentation?

Users report here documentation bugs, and Moderators take effort to seek clarification and submit internal tickets. However, these then appear to be ignored.

So what's the point.

JW

14 REPLIES 14
Pavel A.
Evangelist III

>"Every variable/parameter representing a physical quantity shall be documented with its unit of measure"

Add this requirement to the AI prompt to generate the manuals ))

 

but where's the AI going to get it from if the coder didn't put it there in  the first place.

Or are we assuming that the code will also be AI-generated?

STOne-32
ST Employee

Dear @waclawek.jan  @Andrew Neil  @Pavel A. @David Littell ,

 


We really appreciate your proposal and suggestions, as you can imagine how many pages we have in our STM32 documentation if we restrict to only Datasheets , reference manuals and errata-sheets among more than  1000+ part numbers. It is among our resolutions for this year 2024 to enhance the pace of updates, and also give you more visibility on documentations errata using this Community as intermediate solution between the confirmation and the publication date. Stay tuned . @Imen.D 

Ciao

STOne-32

Nikita91
Lead II

No need for documentation: have the AI generate the application directly. Like this no more documentation therefore no more errors in the documentation. Artificial intelligence is heralded as more efficient than natural intelligence...

But if the AI has to generate documentation, it will take its sources from what already exists on the WWW, and therefore it will be worse than now!

Nikita91
Lead II

By the way ST documents are not the worse I know. Take a look at those from Expressif (ESP32)...

There is still some communication between users and ST through this forum, and suggestions can be taken into account.

And the ST French/English translation is better than many Chinese/English translations from other providers!