Re:An API is only as good as its documentation
by buro9 on Monday March 30, 2015 @08:33AM
(#9289029)
I find all of the auto-generated systems produce barely sufficient documentation.
Real documentation is written by a person who understands how to use the API.
Unfortunately, such documentation then suffers bit-rot if it's not updated whenever the API is updated.
What I would like to see is some way to describe an API which can be merged with the hand-written narrative and instructions, and can be refreshed whenever the implementation changes.
Real documentation is written by a person who understands how to use the API.
Unfortunately, such documentation then suffers bit-rot if it's not updated whenever the API is updated.
What I would like to see is some way to describe an API which can be merged with the hand-written narrative and instructions, and can be refreshed whenever the implementation changes.