RE: Doc workflow management

Subject: RE: Doc workflow management
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Oct 2018 10:09:11 +0000 (UTC)

Where I work we use ReviewBoard in general (https://www.reviewboard.org/). This is a code reviewing platform, but you can attach binary files (PDFs and Word) to a review request. We are in a Docs-As-Code situation, where our source is DITA, and we manage it in the source code repository on GIT. For code commits, each commit requires a Jira ID and a ReviewBoard ID.

I'll note, for our purposes ReviewBoard turns out to be overkill in most circumstances. It's easier to just get the SME to review the content and say it's ok. We're still pretty small, and we don't need formal, audited reviews. Also, NOBODY wants to review raw DITA. (We were including PDFs with the ReviewBoard request, but again, it turned out to be overkill.) So we have a DOC category in JIRA, and any commits against a DOC issue do not require a ReviewBoard ID. The commit message just states who gave the OK to that change.

We have some content categories that should be formally reviewed... Min Requirements, technologies we support, etc. These should be stored as source code files that we import into the docs, Then QA can verify that content irrespective of the "book" or other publishing channel it goes out to. I'm trying to set that up, and in that case any content changes to that content would require a full ReviewBoard review.Â
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: "Tech comm trends: Providing value as a generalist in a sea of specialists (Part I)"
Next by Author: Doc workflow management
Previous by Thread: Doc workflow management
Next by Thread: Next TechWhirl Fast 5 on Wednesday: The Convergence of Content


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads