AI for writing documentation

I write my notes, docs, etc in markdown first; this allows me to keep my notes in plain text and I can view them with my text editor with fancy syntax highlights.
My normal documentation are short, concise commentaries in the source. My programs are for personal use. Your approach is good for someone wanting to spend time documenting manually. But even the AI can be used to get a first draft.
 
When I was in college, we were taught to put in the effort to make good comments into code, so that it's readable by both machines and humans. Not writing proper documentation for your own code resulted in 50% deduction of the credit you got for a class assignment.

And now? it seems to be a forgotten skill. 'Vibe coding' is supposedly the 'in' thing, and computers can as well be black boxes that have minds of their own. Like a God or a pet.

[SARCASM]Real programmers don't write documentation. It's the dirty work that needs to be outsourced to the stupid unwashed masses, for as cheap as possible.[/SARCASM]

[SARCASM]Real programmers write the Great American Compiler from scratch, in a hurry, with no commentary, then try to use it to write everything else.[/SARCASM]
 
Back
Top