In this episode, we talk about continuous integration strategies for docs (for style, screenshots, and REST calls). We also dive into discussions around docs as code, including how encourage developer collaboration, how to stay informed about code updates developers make, and more.
In this episode, we discuss top technical writing trends for 2017. Chris discusses how more technical writers are interacting with support groups, and even being embedded within support departments. Jared discusses how docs are being planned for earlier in development cycles, as more product managers are seeing the value of docs. Tom talks about how more technical writers are treating documentation as code, and the challenges inherent in developer tools and workflows.
In episode 2 of the Write the Docs podcast, we explore how to help users find what they're looking for in your documentation. We talk about various tools for findability - search, tags, faceted filters, sidebar navigation, inline links, related links, terms/glossaries, and breadcrumbs.
The past two weeks have been so eventful and I have so much to say about them it's hard to know where to start. Consequently, this episode may ramble and go off at tangents, hopefully there will be enough semblance of sense to grasp some concrete concepts. Let's take this chronologically and in order of magnitude, which in this case, are the same.
In this first episode, we introduce the co-hosts, the podcast theme, and chat about a few articles. The four co-hosts include Jared Morgan, Carlee Potter, Chris Ward, and Tom Johnson. We're located in Sydney, Brisbane, Berlin, and California. In this episode, we chat about content strategy, style guides, abbreviations and acronyms, developer-written UI copy, and more.