Re: Documentation collaboration - best practices and tools used?

Subject: Re: Documentation collaboration - best practices and tools used?
From: Shawn <shawn -at- cohodata -dot- com>
To: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
Date: Fri, 31 Oct 2014 08:47:11 -0700

Good morning Stuart,

>PDF: Acrobat/Adobe Reader is very capable as a review tool as long as
reviewers are not trying to make large-scale additions.

My testing of its Shared Review via webDAV server was somewhat successful.
I think I will be able to leverage this tool, as part of my documentation
workflow. The only perplexing piece is that the PDF, to review, doesn't
seem to embed the webDAV authentication. This means that each reviewer
needs to know the user name and password to the webDAV server. That seems
rather odd and not very smart security management.

>Confluence is worth a second look. We don't use it for external documents,
but the templates and macros to support

At this time, I do not see any value in paying for this product when we
already have Google Apps as a central part of our business. On the other
hand, jira is core to our business... so I will allow the adoption of
Confluence to become more of a engineering decision.

Thanks for your input. :)

Shawn

On Thu, Oct 30, 2014 at 6:53 PM, Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
wrote:

> Hi Shawn.
>
> PDF: Acrobat/Adobe Reader is very capable as a review tool as long as
> reviewers are not trying to make large-scale additions. A two-minute
> demo or half-page cheat sheet will tell reviewers how to use the
> insert, delete, replace, highlight and note tools. Changes or
> additions larger than a paragraph or two could be drafted in a
> separate Google Doc with a comment showing the URL.
>
> Confluence is worth a second look. We don't use it for external
> documents, but the templates and macros to support developing and
> publishing tech docs do seem to have matured a lot in the last couple
> of years. I don't really like the WYSIWYG editor but it's comparable
> to Google Docs, so if an author can handle drafting material in one
> they should be able to handle the other.
>
> --- Stuart
>
>

--
*Shawn Connelly*
Technical writer

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

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

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


References:
Re: Documentation collaboration - best practices and tools used?: From: Stuart Burnfield

Previous by Author: Re: Documentation collaboration - best practices and tools used?
Next by Author: Steven Pinker lecture on writing/style
Previous by Thread: Re: Documentation collaboration - best practices and tools used?
Next by Thread: Sizing question


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

Sponsored Ads


Sponsored Ads