Tools FAQ for API doc site
Here are the initial questions I included:
Is it possible to author API documentation using DITA/XML or an XML editor (like Oxygen)? I saw your recommended list of tools in the Publishing API docs section, but it would be great if we could leverage existing tools.
We use Madcap Flare but document our APIs in Swagger. We’re considering dropping Flare and using Readme.com instead, which can import Swagger, but should we be looking at other tools? We also don’t document just APIs, but have protocols we document outside of the APIs too.
We’re considering using GitHub as our documentation CMS, but we’re unsure what it can support. Does it provide a documentation portal? HTML generation? An editor to add/update content? Themes? bi-directional sync with Git? Overall, what is the process flow if it allows documentation?
You can read my responses in the Tools FAQ.
By the way, I’m never quite sure what to call FAQ pages. They tend to be a catch-all for every question not answered elsewhere, not necessarily frequently asked questions. Some people despise FAQs, while others like them. However, I do think they are useful pages to hang a lot of questions not covered elsewhere.
About Tom Johnson
I'm a technical writer based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.