initial list of documentation topics - Githubissues

dret / APIdocumentation

1 stars 0 forks source link

initial list of documentation topics #1

Open dret opened 7 years ago

dret commented 7 years ago

here's an initial list of documentation topics that could be listed:

metadata as a starting point: service-metadata
technical information: service-desc
human-readable information: service-doc
status information: service-status
terms of service: terms-of-service
licensing: license
extensibility model
change management
sunsetting
contact information: about

dret commented 7 years ago

one more, inspired by https://thenewstack.io/no-testing-no-documentation-no-problem/:

code examples

dret commented 7 years ago

some more, taken from https://swaggerhub.com/blog/api-documentation/best-practices-in-api-documentation/:

authentication
error messages
change log

dret commented 7 years ago

some more, inspired by thoughts around easy ways to get started:

onboarding (what's required to start using the API)
billing (anything related to payment, including pricing and payment options)