AnsweredAssumed Answered

Any recommendation for WYSIWYG editor for API documentation?

Question asked by AshAlam on Mar 17, 2015
Latest reply on Apr 16, 2015 by Dustin Dauncey

Groups in our company are getting ready to expose a number of APIs through the API portal. One of the concerns they had was the effort required to populate, maintain, update API documentation for the number of APIs they are looking to expose.

 

Today we leverage the CMS user role and give users templates to fill in documentation (template is essentially just a document with html directives such as br, div, h1, h2 etc.) to help teams populate the content and then we essentially publish that in staging and then to prod.

 

The process of writing html document is difficult for some. Do you have any recommendation for any editor (perhaps some sort of WYSIWYG editor) that can make this process easier for folks who may not be as familiar with html?

 

Disclaimer: I personally haven't written any API documentation on the API portal. Just trying to address the concern I heard from some of the teams.

Outcomes