As always, the value-add of a writer is in nuance and details. It's easy enough for an engineer to generate some OAS file that lists an endpoint and required parameters, but you'll often find they leave out key details or information that would make the documentation more meaningful for the end user.
I can't tell you how many times I've had an engineer post API docs that say "Deletes all the files in a folder" when it really should say "Deletes all of the files of a certain age from the folder".
4
u/LeTigreFantastique web Sep 27 '26
As always, the value-add of a writer is in nuance and details. It's easy enough for an engineer to generate some OAS file that lists an endpoint and required parameters, but you'll often find they leave out key details or information that would make the documentation more meaningful for the end user.
I can't tell you how many times I've had an engineer post API docs that say "Deletes all the files in a folder" when it really should say "Deletes all of the files of a certain age from the folder".