briandominick / codewriting

Source for Codewriting (book) and the Codewriting/Code the Docs (site/blog)
Other
50 stars 13 forks source link

Docs as Code section - Content APIs #18

Open lief-erickson opened 6 years ago

lief-erickson commented 6 years ago
  1. All content can be single-sourced, meaning tech writers and engineers maintain one canonical source of truth, no matter how many places that content needs to appear in the generated docs.

This touches on, albeit without saying as much, as Docs as a Service or Content APIs. Content can be subscribed to and pull in based on requests. Consider pulling content into a mobile app, for instance. Too early to reference this sort of pipeline?

briandominick commented 6 years ago

Yeah this is great stuff. I don't know enough about it, and I knew even less when I was brushing up against it here.

briandominick commented 6 years ago

Lief I'm definitely interested in resources on this, or, frankly, a direct contribution.

lief-erickson commented 6 years ago

A Google search for "content api" turns up several resources. I have not used any of these, but am familiar that such things exist.

Contentful Seabourne Programmableweb seems to point to a lot of different tools making use of content APIs

briandominick commented 6 years ago

Ah okay, cool. I'll race you to it, then!