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.
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
