Discussion on: Yet another documentation dispute

mdabek profile image
Marek Dabek Author

I have doubts about your approach to API docs. One of the assessments I am doing, when selecting a piece of software is reviewing the API, which gives me a rough idea about what the software is capable of.

codemouse92 profile image
Jason C. McDonald

Sure, there may be other reasons to have API docs. The problem is when these are offered as full replacements for end-user documentation...which is exactly what happens in a disgustingly large number of projects.

At the same time, if you're having to read the API docs to figure out what the software does, it means someone didn't actually document it properly.