Which AI tool do you use for documentation?

I don't use AI for documentation.

For serious projects I will usually run separate hardware and software documentation  streams.

The documentation starts before and CAD or IDE are used.

The idea is to describe things before the tools start to get in the way. As the design progresses you develop the documentation and then the code/schematic etc.

For example - if you will use a micro-controller you need to decide which one. To make a good choice you need to know what it is going to do - and the design notes (as I call them) are used to develop ideas and define them in increasing detail.

It is generally accepted that very early design decisions often define most of the project - and so they are very important. If you use AI to do this you will have delegated most of the cost of the development in that first one page description you give the AI.

Of course documentation written after the event is crazy - if you have to describe the design when its complete it should prompt you to at least wonder how you got there !

I can't see where AI comes into a good design process - except as maybe a spell checker.

I suspect that I am already in a minority - welcome to the 20230s - where AIs will use terawatt hours  of energy to produce peta Pages of output which other AIs will summarise down to .......

MK

Hi, I agree with michaelkellett . The documentation process should begin before you build your solution, as it helps ensure that the software or hardware you design is robust and meets the project requirements.

On the other hand, when working on critical applications, as in my case, and especially when the solution needs to be certified, the use of AI tools may not be permitted during the documentation process. The author, reviewer, and approver must be identifiable individuals in order to ensure proper accountability and traceability.

Generative AI tools can also show a tendency toward sycophancy or excessive agreement with the user. This can be a serious drawback when designing complex systems, because a good engineering process requires critical thinking, independent verification, and the ability to challenge incorrect assumptions.

Hi, I agree with michaelkellett . The documentation process should begin before you build your solution, as it helps ensure that the software or hardware you design is robust and meets the project requirements.

On the other hand, when working on critical applications, as in my case, and especially when the solution needs to be certified, the use of AI tools may not be permitted during the documentation process. The author, reviewer, and approver must be identifiable individuals in order to ensure proper accountability and traceability.

Generative AI tools can also show a tendency toward sycophancy or excessive agreement with the user. This can be a serious drawback when designing complex systems, because a good engineering process requires critical thinking, independent verification, and the ability to challenge incorrect assumptions.

That's why agentic documentation is becoming essential. Instead of reading through pages of documentation, users can simply ask questions and get the answers they need instantly.

It depends on the type of documentation.

Take a sequence diagram, for example. You would often create one initially based on an initial design concept aimed at meeting scope / specification. You might then test the validity through simulation and coding. That's the linear approach.

Now with AI I can take raw code and say to the AI agent "create a sequence chart" and it does it. That's going a full circle. I can now check the code review's sequence of events against intended. See if they match etc. Alternatively, you could skip the initial diagram, and jump straight to code. Then test, but get AI to code review etc. as well.

In my opinion this whole documentation approach is evolving thanks to new tools and techniques.

Ready, Fire, Aim !

MK

The main sw desing regulations for critical systems like DO-178C,  AQAP-2210 and the basic V validation follow this schema, document your design first according to your system requirements, implement your solution and then document the final solution and the test that you was made to ensure that the requirements are satisfied. But I known that if work in a small or self made project this process may seem ineficiente.

The trades have moved on. Documentation 1st has never been efficient. 1980s are over