Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 3,505

Stitcher radio

follow us in feedly

Want more tech comm blogs to follow? See my Tech Comm Collection of Blogs on Feedly.

Adobe Robohelp

Question: How do I add my DITA content in Confluence for SME review?

Jan 9, 2015 • general

Someone recently asked me:

I am using DITA with structured Frame and Tech Comm Suite. Do you know the best output to use so the docs can be displayed in Confluence? The SMEs want to proofread in Confluence and use it for a knowledge base. Ideally, I'd like to output from DITA or Robohelp and then just upload to Confluence.

Great question! Mixing DITA and Confluence is a major challenge. I noted in my API doc survey that about a third of people working in the API doc space are using Confluence in some way. This poses a challenge if you're using DITA.

However, I recommend not porting the DITA content into Confluence. People may think they want to review content in Confluence because they're reviewing other content here and are familiar with the platform. However, if your content is in DITA, there's no easy way to get it in and out of Confluence without copying and pasting (as far as I know).

I'm not that familiar with the reviewing capabilities built into Adobe TCS. I use the Webhelp with Feedback option in OxygenXML (I have some detailed notes on it here). In the past, I've also imported imported my DITA content into a WordPress site to allow people to add comments.

Whatever method you use for SME review, try to find a method that allows these capabilities:

  • The ability to iterate on the content during review (based on incoming feedback) so you can update topics before other reviewers begin their review.
  • The ability for reviewers to interface with each other via comments.
    Historical comments so other reviewers can see the evolution of the content.
  • The ability to present the content in the same form that users will view it in (rather than a rendered PDF or Word document).
  • The ability for reviewers to review the content asynchronously on their own schedules and times.
  • The ability for reviewers to see the updates you've already made to the content so they know their recommendations don't fall on deaf ears.
  • The ability for reviewers to continue their review post-release since people are usually busy up until release time.

I elaborated with more detail here: Reviewing draft DITA content with subject matter experts: 6 essential points. Based on these considerations, I decided to use the Webhelp with Feedback option with Oxygen, but I'm also using Oxygen, so it fits well into my toolset and workflow.

How would you answer this person's question? What recommendations or best practice advice can you offer?

follow us in feedly


Get new posts delivered straight to your inbox.

Subscriber count: 3,505

Powered by ZipRecruiter

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.
http://idratherbewriting.com/2015/01/09/question-how-do-i-add-my-dita-content-in-confluence-for-sme-review/
idratherbewriting.com
crawl=CC-MAIN-2016-50
41979
application/http; msgtype=response
sha1:R6BXSJUMANOZCR45E747PDXUHT763LKQ
<urn:uuid:c4da0a90-8087-4e63-b81a-d59580d4c737>
2016-12-10T10:42:40Z
192.30.252.154
sha1:7JKCG3FSXIGKFPKUTX6RZ6CH4UF32WYD
<urn:uuid:56f826df-7fae-4684-9321-3f1827ae8857>
http://idratherbewriting.com/2015/01/09/question-how-do-i-add-my-dita-content-in-confluence-for-sme-review/
length
response
<urn:uuid:961a6102-23af-4b0f-bbd3-6ce43b724c8b>
robots: classic
hostname: ip-10-31-129-80.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2016-50
operator: CommonCrawl Admin
description: Wide crawl of the web for November 2016
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf