TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
