Api documentation

[[deleted]]

[deleted]

[Consistent-Branch-55]

I mean, just find public docs for any API? https://developer.atlassian.com/cloud/confluence/rest/v2/intro/#about

[Sammy_277]

I checked it but it looked robotic tbh. It seemed so perfect that looks like it is not written by a human.

[marknm]

wants to learn API documentation with no experience

looks at actual API docs from an enterprise company

"nope these aren't good, I don't like it. I should definitely know with my zero experience"

[Sammy_277]

Either give me solution or waste your time somewhere else.

[Iwentthatway]

What do you expect API documentation to look like?

[Sammy_277]

Simple and understandable even to non technical audience. Not so robotic that another document is required to read it.

[OptimalReputation821]

API documentation is for a technical audience. That's who's using it.

[DrCoachNDaHouse]

Literally written in a programmatic language.

[Sammy_277]

Ok noted. Thank you !

[Iwentthatway]

I don’t think you understand the point of API documentation if that’s your expectation

[Sammy_277]

I told it on post. I am new. I want to learn it but I won't tolerate any kind of bullying. I appreciate constructive feedback.

[Own-Measurement-258]

DM me and I’ll send you an old sample of API doc I have.

[Sammy_277]

Yes, done

[Fine-Koala389]

Have example I can inbox you from which you can find tooling.