search

civicrm / org.civicrm.api4

CiviCRM api version 4
Other
8 stars 19 forks source link

Design Principles: add "Documented" #15

Open ErichBSchulz opened 7 years ago

ErichBSchulz commented 7 years ago

I think this one is a no-brainer?

(although it may redefine and complicate what constitutes an MVP)

I encountered this recommendations for what at least one random internet person considered to be examples of excellent and detailed documentation: Twilio, Django, and MailChimp (for reference)

seancolsen commented 7 years ago

Huge +1 for this :smile:

JoeMurray commented 7 years ago

I would make this more specific in some way to reflect the burden of keeping some sorts of documentation up to date, since out of data documentation is worse than no documentation. For DX, I've been very pleased with the way the API explorer documents how to use the API for simple calls. I'd love to see better support for non-experts trying to create chained calls in the tool.