AI for writing documentation

[hruodr]

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.

 

[zester]

ok...this is getting annoying , is there some how of block words in the forum? like AI???????

Well you could just not participate in a forum topic titled "AI for writing documentation"

 

[wolffnx]

yes, the AI lover boy dont appear no more ..it works
"ignore" is the keyword

 

[astyle]

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]

 

[Espionage724]

"ignore" is the keyword

Imo that shouldn't even be a feature on public forums; if you're on the forum you already agree to its contents, and it forum moderators find it fine why self-censor?

Afaik someone posting positively about AI one day doesn't necessarily define their character or who they are; they might talk about something completely different like source code for something on ports; would you benefit from not seeing potentially useful information because of past discussion? Maybe later they'll post something anti-AI, but it wouldn't be seen because of the previous AI-related ignore block.

Worst-case I imagine it affects conversation flow on threads if someone is willingly blocking posts from one user and selectively responding (when they could respond to the blocked poster and have others able to be included too; the block only serves privately on a public forum); I prefer organic anything-goes

 

[bakul]

Imo that shouldn't even be a feature on public forums; if you're on the forum you already agree to its contents, and it forum moderators find it fine why self-censor?

It is perfectly fine to ignore people for whatever reason! Better to ignore some people than try to force them to stop (because they're never going to) or to escalate things further. Even on Usenet we had "killfiles" to ignore (mainly) trolls.

would you benefit from not seeing potentially useful information because of past discussion?

So it goes!

 

[CShell]

Can't you just use a text editor to write things?

LOL --- I used to write entire papers using nroff(1) and vi(1) ...

But then WYSIWYG came along and everyone switched to that.

nroff(1) is a dying art I guess...

 

[CShell]

But.. in answer to your original question. man(1) pages were usually hand created using vi(1) and/or emacs(1) or similar back in the day. Of course we just copied (another) existing man(1) page and edited that file into a new man page for our needs.

This is how... the UNIX was won !

 

[cracauer@]

TeX or nuffin'.

 

[CShell]

TeX or nuffin'.

Edited: Yup - there is LaTeX too .

 

[atax1a]

still is!

 

[wolffnx]

Imo that shouldn't even be a feature on public forums; if you're on the forum you already agree to its contents, and it forum moderators find it fine why self-censor?

Afaik someone posting positively about AI one day doesn't necessarily define their character or who they are; they might talk about something completely different like source code for something on ports; would you benefit from not seeing potentially useful information because of past discussion? Maybe later they'll post something anti-AI, but it wouldn't be seen because of the previous AI-related ignore block.

Worst-case I imagine it affects conversation flow on threads if someone is willingly blocking posts from one user and selectively responding (when they could respond to the blocked poster and have others able to be included too; the block only serves privately on a public forum); I prefer organic anything-goes

agree about that, is not fine blocking or ignore someone only for a word and asume the class of people he are for that,
maybe is a good person
but..is AI lover, and they are a virus, today is a post,tomorrow another,and again..and again..and again
hey, I dont want to see it, AI toilets / AI for wiping their ass /AI OS..etc...etc..
is a big NO