*gently grabs the cheeks of all programmers to stare deeply into their eyes*
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone I don't have enough soapboxes to empathise fully with your post.
I'm a tech writer and (former?) programmer, with empathy.
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone You are in good company.
I think, related to this, is that I want software to change more slowly. More contemplation. More thought. More pause. One new version per year, thought through with more intentionality.
-
@GentlemanTech @CorvidCrone AWS and Cisco, also.
@drwho @GentlemanTech @CorvidCrone AWS IAM docs are a trash fire. Half the examples just shrug and use wildcards. String matching, for access control primitives, because not even the insiders have accurate reference documentation.
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone Have you tried FreeBSD man pages? I wrote a ton of them in 2003.
-
@CorvidCrone Oh OK. Sorry to hear that. I thought you were inquiring generally as to who writes "proper manuals"; FreeBSD generally tries to do that with traditional UNIX-style manual pages. I hope you find your tech writer.
-
@CorvidCrone Oh OK. Sorry to hear that. I thought you were inquiring generally as to who writes "proper manuals"; FreeBSD generally tries to do that with traditional UNIX-style manual pages. I hope you find your tech writer.
@bms48 I just want programs that average people have to use to come with actual instructional manuals.
Like I said, my rice cooker came with an extensive instruction manual, including what sounds are normal and what sounds are cause for concern.
My Subaru also came with an actual user manual, so years after I bought it used, I can still look up what that suddenly flashing new alert icon is for and address it before it becomes an expensive problem.
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone you used to get these with some pieces of software. Back when software was for CP/M or DOS. What the heck happened?
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
ahem, is there a manual for mastodon ? bluesky ?
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone A series of promotional learning videos, gotcha. Coming right up
-
@CorvidCrone not a bloody video. Honestly the UNIX man pages had the correct paradigm.
@chrisgerhard @CorvidCrone this, plus the very nice info pages for more structured details. Preferably read in #emacs, but there are plenty alternatives.
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone GIVE ME MAN PAGES OR GIVE ME DEATH
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone the ZX81 BASIC manual is my role model
-
@CorvidCrone I miss the time when software came with manuals fit for knocking out your manager in case he gave you shit for still reading through the War-and-Peace-sized manual
@dequbed @CorvidCrone I remember when all tech manuals, and really, it was all of them, had an ASCII chart in the appendices
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone
I learned my programming skills with books listing all instructions in ALPHABETICAL order with explanations.
I just went and read it all from A to Z. And then I knew how the language works. -
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone so much this, for tech tools too. The datadog docs are all marketing crap and installation guides with very little actual information, for example. https://diataxis.fr/
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
@CorvidCrone preach!
-
*gently grabs the cheeks of all programmers to stare deeply into their eyes*
All I want is a dry tech manual. A boring, well indexed manual that defines every function. Not a chatbot. Not a training. Not a million "articles" that I have to search through. Not a "community forum".
My rice cooker came with one. I want one for every piece of software I have to interact with.
Go get yourself a technical writer if necessary.
I. Want. An. Instructional. Manual.
If this happens to be the sole surviving text of our civilization it will leave a good deal of room for interpretive detail.
Though for the most part they'll just label it as obscure religious poetry, much as they did for a century or so with the commercial bill of lading figurines that turned out to be the actual origins of the alphabet, on a closer view.
-
If this happens to be the sole surviving text of our civilization it will leave a good deal of room for interpretive detail.
Though for the most part they'll just label it as obscure religious poetry, much as they did for a century or so with the commercial bill of lading figurines that turned out to be the actual origins of the alphabet, on a closer view.
@glc I would be honored if one of my social media posts became the sole surviving text of our civilization.
Honored and horrified.
-
@glc I would be honored if one of my social media posts became the sole surviving text of our civilization.
Honored and horrified.
-
This is, in principle, how things should work.
This, of course, depends on the documentation writer being a competent communicator. Which, in the tech world certainly, is by no means a given.
The above is also true of websites.
But figuring out what the writer called the thing, and where they put it....
This can be a challenge.
(To be clear: hard agree.)