Document 360: #1 Knowledge Base Software
Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,500+ subscribers. (See email archive here.)

Search results

Document 360: #1 Knowledge Base Software

Coffee and Content webinar recording: Treat Code Like Code; Treat Prose Like Prose

by Tom Johnson on Oct 2, 2020 •
categories: api-doc

I recently participated in an upcoming Coffee and Content webinar called Treat Code Like Code; Treat Prose Like Prose on September 24, 2020, with Scott Abel and Casey Jordan. A recording of the video is now available.

Video recording now available

Coffee and content webinar: Treat code like code; treat prose like prose

Coffee and Content webinar details

Here’s the Coffee and Content webinar description:

Treat Code Like Code; Treat Prose Like Prose

Join us for a Coffee and Content chat with Tom Johnson about what it means to “treat code like code and prose like prose.” In the docs-as-code tools space, a popular method for reviewing docs is to review docs using the same code review tools that software engineers use to review code. Code review tools cater to engineering workflows and preferences, for sure. If you want an engineer to review a change in your docs, it makes sense to use the same review method the engineer is accustomed to using for reviewing code.

However, good docs require input from people outside of engineering roles. Product managers, field engineers, quality assurance, support engineers, legal advisors, UX, and other stakeholders also need to review docs. A review process that excludes these non-engineering roles can be problematic, especially since these other roles often serve as a check and balance against the features engineering teams create. Sometimes it’s better to treat docs more like prose instead of code.

Date: Sept 24, 2020
Time: 8:00am PST
Channel: BrightTALK
Cost: Free
Registration: You can register here.

Upcoming Coffee and Content webinar: Treat Code Like Code; Treat Prose Like Prose

Background

This topic came about after I wrote a post called Treat code like code and prose like prose. I think this post falsely gave the impression that I was somehow abandoning the docs-as-code workflow, when in fact I was just pushing back on code review tools as a primary form of doc review given that code review tools cater almost exclusively to engineers. My point was that a good review process is more inclusive of other roles (such as PMs and field engineers). A code review for doc changes might still be appropriate to target engineer reviewers, or as part of a formal release process.

Discussion topics

Possible questions/topics for this webinar include the following:

  • What does docs-like-code mean?
  • Why do writers in this space often use code review tools to review docs?
  • What did your dev doc survey find about the popularity of using code review tools?
  • What’s required to get your docs into a code review tool?
  • What are the advantages of reviewing docs like this? What visibility and rapport does this give you with other engineers?
  • What are some of the disadvantages of reviewing docs like this?
  • Is there a danger of excluding non-engineering roles in the review process?
  • Why can’t they just use the code review tools to review content?
  • Do we sometimes over-index on treating docs too much like code? Is content development (prose) unique from code development? In what way do they differ?
  • What does it mean to treat prose like prose and code like code?
  • What is the ideal review process for docs?
  • How do you port content from a collaborative system where many reviewers feel comfortable leaving comments back into your documentation tool?
  • What were the results of your survey regarding what others think of treating code like code and prose like prose?
  • What other tips do you have for getting others to review documentation?
Buy me a coffeeBuy me a coffee
Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,500+ subscribers. (See email archive here.)

follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer based in the San Francisco Bay 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.

Comments