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.
Recently we also got a request to create reference architecture documents
(because they are supposed to be common), and have a similar problem
finding out what they should be. The only difference is that we got the
requests from our presales guys and partners, so it should be more
technical, something like a deployment concept for specific scenarios, and
the product-related tutorial on how to actually configure the product for
that scenario.
HTH,
Robert
On Thu, Jun 30, 2016 at 9:00 PM, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:
> 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 fekete77 -dot- robert -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
