Re: Reference Architecture document

Subject: Re: Reference Architecture document
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 30 Jun 2016 12:00:25 -0700

I'd ask questions to define the doc's intended use.

If the primary use is for sales, is the goal that the potential
customer can use it to see what they'd need to buy or change before
they could deploy? If not, what?

Is there an installation / deployment guide? If so, the information
should all be in there, and this doc would just be a reorganized
subset, without the procedural stuff.

On Wed, Jun 29, 2016 at 1:56 PM, Helen Mullally
<helen -dot- mullally -at- alfresco -dot- com> wrote:
> Iâve been asked to take on the creation and production of a Reference Architecture document, covering the hardware, software, and processes for a deployment. The document is intended primarily to support the sales process, rather than being a part of the product documentation.
>
> Has anybody got any experience of writing or managing the production of a Reference Architecture document?...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://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


References:
Reference Architecture document: From: Helen Mullally

Previous by Author: Re: "Creative Technical Writing"
Next by Author: Re: Track Changes: A Literary History of Word Processing review â did tech change literary style?
Previous by Thread: RE: Reference Architecture document
Next by Thread: RE: Reference Architecture document


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

Sponsored Ads


Sponsored Ads